Class: SolidBelongsToOneRelation<Parent, Related, RelatedClass>
Defined in: packages/soukai-solid/src/models/relations/SolidBelongsToOneRelation.ts:18
Extends
SolidSingleModelDocumentRelation
<Parent
,Related
,RelatedClass
>.SolidBelongsToRelation
.SolidBelongsToOneRelationBase
<Parent
,Related
,RelatedClass
>
Type Parameters
Parent
Parent
extends SolidModel
= SolidModel
Related
Related
extends SolidModel
= SolidModel
RelatedClass
RelatedClass
extends SolidModelConstructor
<Related
> = SolidModelConstructor
<Related
>
Implements
Constructors
Constructor
new SolidBelongsToOneRelation<
Parent
,Related
,RelatedClass
>(parent
,relatedClass
,foreignKeyName?
,localKeyName?
):SolidBelongsToOneRelation
<Parent
,Related
,RelatedClass
>
Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:16
Parameters
parent
Parent
relatedClass
RelatedClass
foreignKeyName?
string
localKeyName?
string
Returns
SolidBelongsToOneRelation
<Parent
, Related
, RelatedClass
>
Inherited from
SolidBelongsToRelation
.constructor
Properties
__modelInOtherDocumentId?
optional
__modelInOtherDocumentId:string
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:34
Inherited from
SolidSingleModelDocumentRelation
.__modelInOtherDocumentId
__modelInSameDocument?
optional
__modelInSameDocument:Related
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:33
Inherited from
SolidSingleModelDocumentRelation
.__modelInSameDocument
_related?
protected
optional
_related:null
|Related
|Related
[]
Defined in: packages/soukai/src/models/relations/Relation.ts:32
Implementation of
SynchronizesRelatedModels
._related
deleteStrategy
deleteStrategy:
RelationDeleteStrategy
=null
Defined in: packages/soukai/src/models/relations/Relation.ts:31
Implementation of
SynchronizesRelatedModels
.deleteStrategy
documentModelsLoaded
protected
documentModelsLoaded:boolean
=false
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidDocumentRelation.ts:23
Inherited from
SolidSingleModelDocumentRelation
.documentModelsLoaded
enabled
enabled:
boolean
=true
Defined in: packages/soukai/src/models/relations/Relation.ts:30
Implementation of
SynchronizesRelatedModels
.enabled
foreignKeyName
foreignKeyName:
string
Defined in: packages/soukai/src/models/relations/Relation.ts:28
Implementation of
SynchronizesRelatedModels
.foreignKeyName
localKeyName
localKeyName:
string
Defined in: packages/soukai/src/models/relations/Relation.ts:29
Implementation of
SynchronizesRelatedModels
.localKeyName
name
name:
string
Defined in: packages/soukai/src/models/relations/Relation.ts:25
Implementation of
SynchronizesRelatedModels
.name
parent
parent:
Parent
Defined in: packages/soukai/src/models/relations/Relation.ts:26
Implementation of
SynchronizesRelatedModels
.parent
relatedClass
relatedClass:
RelatedClass
Defined in: packages/soukai/src/models/relations/Relation.ts:27
Implementation of
SynchronizesRelatedModels
.relatedClass
useSameDocument
useSameDocument:
boolean
=false
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidDocumentRelation.ts:21
Inherited from
SolidSingleModelDocumentRelation
.useSameDocument
inverseBelongsToRelationClasses
static
inverseBelongsToRelationClasses:Constructor
<Relation
<Model
,Model
,ModelConstructor
<Model
>>>[] =[]
Defined in: packages/soukai/src/models/relations/Relation.ts:23
inverseHasRelationClasses
static
inverseHasRelationClasses:Constructor
<Relation
<Model
,Model
,ModelConstructor
<Model
>>>[] =[]
Defined in: packages/soukai/src/models/relations/Relation.ts:22
Accessors
__newModel
Get Signature
get __newModel():
undefined
|Related
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:45
Returns
undefined
| Related
Set Signature
set __newModel(
value
):void
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:49
Parameters
value
undefined
| Related
Returns
void
Inherited from
SolidSingleModelDocumentRelation
.__newModel
loaded
Get Signature
get loaded():
boolean
Defined in: packages/soukai/src/models/relations/Relation.ts:41
Returns
boolean
Implementation of
SynchronizesRelatedModels
.loaded
protectedSolidBelongsTo
Get Signature
get
protected
protectedSolidBelongsTo():ProtectedSolidBelongsToRelation
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidBelongsToRelation.ts:26
Returns
ProtectedSolidBelongsToRelation
Inherited from
SolidBelongsToRelation
.protectedSolidBelongsTo
related
Get Signature
get related():
undefined
|null
|Related
Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:25
Returns
undefined
| null
| Related
Set Signature
set related(
related
):void
Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:29
Parameters
related
undefined
| null
| Related
Returns
void
Implementation of
SynchronizesRelatedModels
.related
Methods
__beforeParentCreate()
__beforeParentCreate():
void
Defined in: packages/soukai-solid/src/models/relations/SolidBelongsToOneRelation.ts:72
Returns
void
__loadDocumentModels()
__loadDocumentModels(
this
,documentUrl
,document
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidBelongsToRelation.ts:30
Parameters
this
documentUrl
string
document
JsonLDGraph
Returns
Promise
<void
>
Inherited from
SolidBelongsToRelation
.__loadDocumentModels
__synchronizeRelated()
__synchronizeRelated(
other
,models
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/relations/SolidBelongsToOneRelation.ts:80
Parameters
other
this
models
WeakSet
<SolidModel
>
Returns
Promise
<void
>
addRelated()
addRelated(
related
):void
Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:58
Parameters
related
Related
Returns
void
Inherited from
SolidSingleModelDocumentRelation
.addRelated
attach()
Call Signature
attach(
model?
):Related
Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:36
Parameters
model?
Related
Returns
Related
Call Signature
attach(
attributes
):Related
Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:37
Parameters
attributes
Returns
Related
clearForeignAttributes()
clearForeignAttributes(
related
):void
Defined in: packages/soukai/src/models/relations/BelongsToOneRelation.ts:37
Parameters
related
Related
Returns
void
clearInverseRelations()
clearInverseRelations(
model
):void
Defined in: packages/soukai/src/models/relations/Relation.ts:147
Parameters
model
Related
Returns
void
clone()
clone(
options
):this
Defined in: packages/soukai-solid/src/models/relations/SolidBelongsToOneRelation.ts:66
Parameters
options
Partial
= {}
Returns
this
cloneSolidData()
protected
cloneSolidData(this
,clone
):void
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:114
Parameters
this
SolidSingleModelDocumentRelationThis
<Parent
, Related
, RelatedClass
>
clone
SolidSingleModelDocumentRelationThis
<Parent
, Related
, RelatedClass
>
Returns
void
Inherited from
SolidSingleModelDocumentRelation
.cloneSolidData
create()
create(
this
,attributes
):Promise
<Related
>
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:68
This method will create an instance of the related model and call the [[save]] method.
Parameters
this
SolidSingleModelDocumentRelationThis
<Parent
, Related
, RelatedClass
>
attributes
Attributes
= {}
Attributes to create the related instance.
Returns
Promise
<Related
>
Inherited from
SolidSingleModelDocumentRelation
.create
disable()
disable():
void
Defined in: packages/soukai/src/models/relations/Relation.ts:64
Returns
void
enable()
enable():
void
Defined in: packages/soukai/src/models/relations/Relation.ts:60
Returns
void
getLoadedModels()
getLoadedModels():
Related
[]
Defined in: packages/soukai/src/models/relations/Relation.ts:94
Returns
Related
[]
getModels()
getModels():
Promise
<Related
[]>
Defined in: packages/soukai/src/models/relations/Relation.ts:86
Returns
Promise
<Related
[]>
initializeInverseRelations()
initializeInverseRelations(
model
):void
Defined in: packages/soukai/src/models/relations/Relation.ts:134
Parameters
model
Related
Returns
void
isEmpty()
isEmpty():
null
|boolean
Defined in: packages/soukai/src/models/relations/BelongsToOneRelation.ts:11
Returns
null
| boolean
Inherited from
SolidSingleModelDocumentRelation
.isEmpty
isInverseOf()
isInverseOf(
other
):boolean
Defined in: packages/soukai/src/models/relations/Relation.ts:160
Parameters
other
Returns
boolean
isRelated()
isRelated(
related
):boolean
Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:74
Parameters
related
Related
Returns
boolean
Inherited from
SolidSingleModelDocumentRelation
.isRelated
load()
load():
Promise
<null
|Related
>
Defined in: packages/soukai-solid/src/models/relations/SolidBelongsToOneRelation.ts:33
Returns
Promise
<null
| Related
>
loadDocumentModels()
protected
loadDocumentModels(this
,modelsInSameDocument
,modelsInOtherDocumentIds
):void
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:136
Parameters
this
SolidSingleModelDocumentRelationThis
<Parent
, Related
, RelatedClass
>
modelsInSameDocument
Related
[]
modelsInOtherDocumentIds
string
[]
Returns
void
Inherited from
SolidSingleModelDocumentRelation
.loadDocumentModels
onDelete()
onDelete(
strategy
):this
Defined in: packages/soukai/src/models/relations/Relation.ts:102
Parameters
strategy
Returns
this
onRelatedUpdated()
protected
onRelatedUpdated(oldValue
,newValue
):void
Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:81
Parameters
oldValue
Nullable
<Model
>
newValue
Nullable
<Model
>
Returns
void
removeRelated()
removeRelated(
related
):void
Defined in: packages/soukai/src/models/relations/SingleModelRelation.ts:66
Parameters
related
Related
Returns
void
reset()
reset(
related
):void
Defined in: packages/soukai-solid/src/models/relations/SolidBelongsToOneRelation.ts:49
Parameters
related
Related
[] = []
Returns
void
resolve()
resolve():
Promise
<null
|Related
|Related
[]>
Defined in: packages/soukai/src/models/relations/Relation.ts:78
Returns
Promise
<null
| Related
| Related
[]>
Deprecated
This method has been renamed to load
.
save()
save(
this
,model
):Promise
<Related
>
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:85
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
SolidSingleModelDocumentRelationThis
model
Related
Related model instance to save.
Returns
Promise
<Related
>
Inherited from
SolidSingleModelDocumentRelation
.save
setForeignAttributes()
setForeignAttributes(
related
):void
Defined in: packages/soukai/src/models/relations/BelongsToOneRelation.ts:27
Parameters
related
Related
Returns
void
static()
static():
RelationConstructor
<SolidBelongsToOneRelation
<Parent
,Related
,RelatedClass
>>
Defined in: packages/soukai/src/models/relations/Relation.ts:56
Returns
RelationConstructor
<SolidBelongsToOneRelation
<Parent
, Related
, RelatedClass
>>
synchronizeRelated()
protected
synchronizeRelated(this
,other
,models
):Promise
<void
>
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidSingleModelDocumentRelation.ts:175
Parameters
this
SolidSingleModelDocumentRelationThis
<Parent
, Related
, RelatedClass
>
other
SolidSingleModelDocumentRelationThis
<Parent
, Related
, RelatedClass
>
models
WeakSet
<SolidModel
>
Returns
Promise
<void
>
Inherited from
SolidSingleModelDocumentRelation
.synchronizeRelated
unload()
unload():
void
Defined in: packages/soukai/src/models/relations/Relation.ts:98
Returns
void
usingSameDocument()
usingSameDocument(
useSameDocument
):this
Defined in: packages/soukai-solid/src/models/relations/mixins/SolidDocumentRelation.ts:25
Parameters
useSameDocument
boolean
= true
Returns
this