Class EmbeddedEntityList<T, E>

Type parameters

T: IResourceFactory<IHasTypedEmbeddedEntity<T, E>>
E: IEmbeddedEntity

Hierarchy

EmbeddedEntityList

Implements

IEmbeddedEntityList<E>

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new EmbeddedEntityList<T, E>(options: IEmbeddedEntityListOptions<T, E>): EmbeddedEntityList<T, E>

- Defined in src/api/activeRecords/common/EmbeddedEntityList.ts:40
Type parameters
- T: IResourceFactory<IHasTypedEmbeddedEntity<T, E>, T>
- E: IEmbeddedEntity
Parameters
- options: IEmbeddedEntityListOptions<T, E>
Returns EmbeddedEntityList<T, E>

Properties

Protected Optional attributes

attributes?: IQueryAttributes<E>

Readonly embeddedType

embeddedType: string | number

Protected entity

entity: IHasTypedEmbeddedEntity<T, E>

Accessors

createCriteria

get createCriteria(): { _embedded: undefined } | { _embedded: {} }

Implementation of IEmbeddedEntityList.createCriteria
- Defined in src/api/activeRecords/common/EmbeddedEntityList.ts:122
Returns { _embedded: undefined } | { _embedded: {} }

length

get length(): number

Implementation of IEmbeddedEntityList.length
- Defined in src/api/activeRecords/common/EmbeddedEntityList.ts:60
Returns number

updateCriteria

get updateCriteria(): { _embedded: undefined } | { _embedded: {} }

Implementation of IEmbeddedEntityList.updateCriteria
- Defined in src/api/activeRecords/common/EmbeddedEntityList.ts:127
Returns { _embedded: undefined } | { _embedded: {} }

Methods

add

add(criteria: object[]): void

Implementation of IEmbeddedEntityList.add
- Defined in src/api/activeRecords/common/EmbeddedEntityList.ts:46
Parameters
- criteria: object[]
Returns void

get

get(): E[]

Implementation of IEmbeddedEntityList.get
- Defined in src/api/activeRecords/common/EmbeddedEntityList.ts:64
Returns E[]

getEmbeddedSaveCriteria

getEmbeddedSaveCriteria(attributes?: keyof E[]): { _embedded: undefined } | { _embedded: {} }

- Defined in src/api/activeRecords/common/EmbeddedEntityList.ts:89
Parameters
- Optional attributes: keyof E[]
Returns { _embedded: undefined } | { _embedded: {} }

Protected pickItemAttributes

pickItemAttributes(item: E, attributes?: keyof E[]): Target

- Defined in src/api/activeRecords/common/EmbeddedEntityList.ts:106
Parameters
- item: E
- Optional attributes: keyof E[]
Returns Target

remove

remove(value?: IEmbeddedEntity[]): void

Implementation of IEmbeddedEntityList.remove
- Defined in src/api/activeRecords/common/EmbeddedEntityList.ts:70
Parameters
- Optional value: IEmbeddedEntity[]
Returns void

set

set(value: null | IEmbeddedEntity[]): void

Implementation of IEmbeddedEntityList.set
- Defined in src/api/activeRecords/common/EmbeddedEntityList.ts:53
Parameters
- value: null | IEmbeddedEntity[]
Returns void

Generated using TypeDoc