Class: OperationsRelation<Parent>
Defined in: packages/soukai-solid/src/models/relations/OperationsRelation.ts:28
Extends
SolidHasManyRelation
<Parent
,Operation
, typeofOperation
>
Type Parameters
Parent
Parent
extends SolidModel
= SolidModel
Constructors
Constructor
new OperationsRelation<
Parent
>(parent
):OperationsRelation
<Parent
>
Defined in: packages/soukai-solid/src/models/relations/OperationsRelation.ts:36
Parameters
parent
Parent
Returns
OperationsRelation
<Parent
>
Overrides
SolidHasManyRelation
.constructor
Properties
__modelsInOtherDocumentIds?
optional
__modelsInOtherDocumentIds:string
[]
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:40
Inherited from
SolidHasManyRelation
.__modelsInOtherDocumentIds
__modelsInSameDocument?
optional
__modelsInSameDocument:Operation
[]
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:39
Inherited from
SolidHasManyRelation
.__modelsInSameDocument
__removedDocumentModels
__removedDocumentModels:
Operation
[] =[]
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:38
Inherited from
SolidHasManyRelation
.__removedDocumentModels
_related?
Defined in: packages/soukai/src/models/relations/Relation.ts:32
Inherited from
deleteStrategy
deleteStrategy:
RelationDeleteStrategy
=null
Defined in: packages/soukai/src/models/relations/Relation.ts:31
Inherited from
SolidHasManyRelation
.deleteStrategy
documentModelsLoaded
protected
documentModelsLoaded:boolean
=false
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidDocumentRelation.ts:23
Inherited from
SolidHasManyRelation
.documentModelsLoaded
enabled
enabled:
boolean
=true
Defined in: packages/soukai/src/models/relations/Relation.ts:30
Inherited from
foreignKeyName
foreignKeyName:
string
Defined in: packages/soukai/src/models/relations/Relation.ts:28
Inherited from
SolidHasManyRelation
.foreignKeyName
localKeyName
localKeyName:
string
Defined in: packages/soukai/src/models/relations/Relation.ts:29
Inherited from
SolidHasManyRelation
.localKeyName
name
name:
string
Defined in: packages/soukai/src/models/relations/Relation.ts:25
Inherited from
parent
parent:
Parent
Defined in: packages/soukai/src/models/relations/Relation.ts:26
Inherited from
relatedClass
relatedClass: typeof
Operation
Defined in: packages/soukai/src/models/relations/Relation.ts:27
Inherited from
SolidHasManyRelation
.relatedClass
useSameDocument
useSameDocument:
boolean
=false
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidDocumentRelation.ts:21
Inherited from
SolidHasManyRelation
.useSameDocument
inverseBelongsToRelationClasses
static
inverseBelongsToRelationClasses:Constructor
<Relation
<Model
,Model
,ModelConstructor
<Model
>>>[] =[]
Defined in: packages/soukai/src/models/relations/Relation.ts:23
Inherited from
SolidHasManyRelation
.inverseBelongsToRelationClasses
inverseHasRelationClasses
static
inverseHasRelationClasses:Constructor
<Relation
<Model
,Model
,ModelConstructor
<Model
>>>[] =[]
Defined in: packages/soukai/src/models/relations/Relation.ts:22
Inherited from
SolidHasManyRelation
.inverseHasRelationClasses
Accessors
__newModels
Get Signature
get __newModels():
Related
[]
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:55
Returns
Related
[]
Set Signature
set __newModels(
value
):void
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:59
Parameters
value
Related
[]
Returns
void
Inherited from
SolidHasManyRelation
.__newModels
loaded
Get Signature
get loaded():
boolean
Defined in: packages/soukai/src/models/relations/Relation.ts:41
Returns
boolean
Inherited from
protectedSolidHas
Get Signature
get
protected
protectedSolidHas():ProtectedSolidHasRelation
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidHasRelation.ts:28
Returns
Inherited from
SolidHasManyRelation
.protectedSolidHas
protectedSolidMulti
Get Signature
get
protected
protectedSolidMulti():ProtectedSolidMultiRelation
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:43
Returns
Inherited from
SolidHasManyRelation
.protectedSolidMulti
related
Get Signature
get related():
undefined
|Related
[]
Defined in: packages/soukai/src/models/relations/MultiModelRelation.ts:25
Returns
undefined
| Related
[]
Set Signature
set related(
related
):void
Defined in: packages/soukai/src/models/relations/MultiModelRelation.ts:29
Parameters
related
undefined
| Related
[]
Returns
void
Inherited from
Methods
__afterParentSave()
__afterParentSave():
void
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:169
Returns
void
Inherited from
SolidHasManyRelation
.__afterParentSave
__beforeParentCreate()
__beforeParentCreate():
void
Defined in: packages/soukai-solid/src/models/relations/SolidHasManyRelation.ts:68
Returns
void
Inherited from
SolidHasManyRelation
.__beforeParentCreate
__loadDocumentModels()
__loadDocumentModels(
documentUrl
,document
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/relations/OperationsRelation.ts:79
Parameters
documentUrl
string
document
JsonLDGraph
Returns
Promise
<void
>
Overrides
SolidHasManyRelation
.__loadDocumentModels
__synchronizeRelated()
__synchronizeRelated(
other
,models
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/relations/SolidHasManyRelation.ts:74
Parameters
other
this
models
WeakSet
<SolidModel
>
Returns
Promise
<void
>
Inherited from
SolidHasManyRelation
.__synchronizeRelated
addRelated()
addRelated(
related
):void
Defined in: packages/soukai/src/models/relations/MultiModelRelation.ts:63
Parameters
related
Returns
void
Inherited from
SolidHasManyRelation
.addRelated
assertLoaded()
protected
assertLoaded(method
):this is { related: Operation[] }
Defined in: packages/soukai/src/models/relations/MultiModelRelation.ts:90
Parameters
method
string
Returns
this is { related: Operation[] }
Inherited from
SolidHasManyRelation
.assertLoaded
attach()
Call Signature
attach(
modelOrAttributes?
):Operation
Defined in: packages/soukai-solid/src/models/relations/OperationsRelation.ts:40
Parameters
modelOrAttributes?
Returns
Overrides
Call Signature
attach<
T
>(attributes
,type
):InstanceType
<Operations
[T
]>
Defined in: packages/soukai-solid/src/models/relations/OperationsRelation.ts:41
Type Parameters
T
T
extends keyof Operations
Parameters
attributes
type
T
Returns
InstanceType
<Operations
[T
]>
Overrides
attachAddOperation()
attachAddOperation(
attributes
):AddPropertyOperation
Defined in: packages/soukai-solid/src/models/relations/OperationsRelation.ts:59
Parameters
attributes
Returns
attachDeleteOperation()
attachDeleteOperation(
attributes
):DeleteOperation
Defined in: packages/soukai-solid/src/models/relations/OperationsRelation.ts:75
Parameters
attributes
Returns
attachRemoveOperation()
attachRemoveOperation(
attributes
):RemovePropertyOperation
Defined in: packages/soukai-solid/src/models/relations/OperationsRelation.ts:63
Parameters
attributes
Returns
attachSetOperation()
attachSetOperation(
attributes
):SetPropertyOperation
Defined in: packages/soukai-solid/src/models/relations/OperationsRelation.ts:67
Parameters
attributes
Returns
attachUnsetOperation()
attachUnsetOperation(
attributes
):UnsetPropertyOperation
Defined in: packages/soukai-solid/src/models/relations/OperationsRelation.ts:71
Parameters
attributes
Returns
clearForeignAttributes()
clearForeignAttributes(
related
):void
Defined in: packages/soukai/src/models/relations/HasManyRelation.ts:46
Parameters
related
Returns
void
Inherited from
SolidHasManyRelation
.clearForeignAttributes
clearInverseRelations()
clearInverseRelations(
model
):void
Defined in: packages/soukai/src/models/relations/Relation.ts:147
Parameters
model
Returns
void
Inherited from
SolidHasManyRelation
.clearInverseRelations
clone()
clone(
options
):this
Defined in: packages/soukai-solid/src/models/relations/SolidHasManyRelation.ts:62
Parameters
options
Partial
= {}
Returns
this
Inherited from
cloneSolidData()
protected
cloneSolidData(clone
):void
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:173
Parameters
clone
SolidMultiModelDocumentRelationThis
<Parent
, Operation
, typeof Operation
>
Returns
void
Inherited from
SolidHasManyRelation
.cloneSolidData
create()
create(
attributes
):Promise
<Operation
>
Defined in: packages/soukai/src/models/relations/MultiModelRelation.ts:55
This method will create an instance of the related model and call the [[save]] method.
Parameters
attributes
Attributes
= {}
Returns
Promise
<Operation
>
Inherited from
detach()
detach(
this
,keyOrModel
):void
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:122
Parameters
this
SolidMultiModelDocumentRelationThis
<Parent
, Operation
, typeof Operation
>
keyOrModel
string
| Operation
Returns
void
Inherited from
disable()
disable():
void
Defined in: packages/soukai/src/models/relations/Relation.ts:64
Returns
void
Inherited from
enable()
enable():
void
Defined in: packages/soukai/src/models/relations/Relation.ts:60
Returns
void
Inherited from
getLoadedModels()
getLoadedModels():
Operation
[]
Defined in: packages/soukai/src/models/relations/Relation.ts:94
Returns
Inherited from
SolidHasManyRelation
.getLoadedModels
getModels()
getModels():
Promise
<Operation
[]>
Defined in: packages/soukai/src/models/relations/Relation.ts:86
Returns
Promise
<Operation
[]>
Inherited from
SolidHasManyRelation
.getModels
getOperationClass()
protected
getOperationClass(resource
):undefined
| typeofOperation
Defined in: packages/soukai-solid/src/models/relations/OperationsRelation.ts:120
Parameters
resource
JsonLD
Returns
undefined
| typeof Operation
initializeInverseRelations()
initializeInverseRelations(
model
):void
Defined in: packages/soukai/src/models/relations/Relation.ts:134
Parameters
model
Returns
void
Inherited from
SolidHasManyRelation
.initializeInverseRelations
isEmpty()
isEmpty():
null
|boolean
Defined in: packages/soukai/src/models/relations/Relation.ts:82
Returns
null
| boolean
Inherited from
isInverseOf()
isInverseOf(
other
):boolean
Defined in: packages/soukai/src/models/relations/Relation.ts:160
Parameters
other
Returns
boolean
Inherited from
SolidHasManyRelation
.isInverseOf
isRelated()
isRelated(
model
):boolean
Defined in: packages/soukai/src/models/relations/MultiModelRelation.ts:81
Parameters
model
Returns
boolean
Inherited from
SolidHasManyRelation
.isRelated
load()
load():
Promise
<Operation
[]>
Defined in: packages/soukai-solid/src/models/relations/SolidHasManyRelation.ts:33
Returns
Promise
<Operation
[]>
Inherited from
loadDocumentModels()
protected
loadDocumentModels(this
,modelsInSameDocument
,modelsInOtherDocumentIds
):void
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:206
Parameters
this
SolidMultiModelDocumentRelationThis
<Parent
, Operation
, typeof Operation
>
modelsInSameDocument
modelsInOtherDocumentIds
string
[]
Returns
void
Inherited from
SolidHasManyRelation
.loadDocumentModels
loadRelatedModels()
protected
loadRelatedModels():Promise
<Operation
[]>
Defined in: packages/soukai-solid/src/models/relations/OperationsRelation.ts:116
Returns
Promise
<Operation
[]>
Overrides
SolidHasManyRelation
.loadRelatedModels
onDelete()
onDelete(
strategy
):this
Defined in: packages/soukai/src/models/relations/Relation.ts:102
Parameters
strategy
Returns
this
Inherited from
onRelatedUpdated()
protected
onRelatedUpdated(oldValue
,newValue
):void
Defined in: packages/soukai/src/models/relations/MultiModelRelation.ts:86
Parameters
oldValue
Nullable
<Model
[]>
newValue
Nullable
<Model
[]>
Returns
void
Inherited from
SolidHasManyRelation
.onRelatedUpdated
remove()
remove(
this
,keyOrModel
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:116
Parameters
this
SolidMultiModelDocumentRelationThis
<Parent
, Operation
, typeof Operation
>
keyOrModel
string
| Operation
Returns
Promise
<void
>
Inherited from
removeRelated()
removeRelated(
related
):void
Defined in: packages/soukai/src/models/relations/MultiModelRelation.ts:71
Parameters
related
Returns
void
Inherited from
SolidHasManyRelation
.removeRelated
reset()
reset(
related
):void
Defined in: packages/soukai-solid/src/models/relations/SolidHasManyRelation.ts:49
Parameters
related
Operation
[] = []
Returns
void
Inherited from
resolve()
Defined in: packages/soukai/src/models/relations/Relation.ts:78
Returns
Promise
<null
| Operation
| Operation
[]>
Deprecated
This method has been renamed to load
.
Inherited from
save()
save(
this
,model
):Promise
<Operation
>
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidMultiModelDocumentRelation.ts:101
This method will bind up all the relevant data (foreignKey, inverse relations, etc.) and save the model. If the parent model does not exist and both models will be stored in the same document, the model will be saved when the parent model is saved instead.
Parameters
this
SolidMultiModelDocumentRelationThis
model
Related model instance to save.
Returns
Promise
<Operation
>
Inherited from
setForeignAttributes()
setForeignAttributes(
related
):void
Defined in: packages/soukai/src/models/relations/HasManyRelation.ts:24
Parameters
related
Returns
void
Inherited from
SolidHasManyRelation
.setForeignAttributes
static()
static():
RelationConstructor
<OperationsRelation
<Parent
>>
Defined in: packages/soukai/src/models/relations/Relation.ts:56
Returns
RelationConstructor
<OperationsRelation
<Parent
>>
Inherited from
unload()
unload():
void
Defined in: packages/soukai/src/models/relations/Relation.ts:98
Returns
void
Inherited from
usingSameDocument()
usingSameDocument(
useSameDocument
):this
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidDocumentRelation.ts:25
Parameters
useSameDocument
boolean
= true
Returns
this