@hydra-cg/heracles.ts > IPartialCollectionIterator
Describes an abstract view of a partial collection. This is an iterator-like pattern that once obtained from it’s owning ICollection should maintain it’s state between consecutive next/previous page calls.
interface:
IPartialCollectionIterator
● currentPartIri: string
Defined in DataModel/IPartialCollectionIterator.ts:14
Gets the IRI of current part.
readonly:
returns:
● firstPartIri: string
Defined in DataModel/IPartialCollectionIterator.ts:21
Gets the IRI to the first part.
readonly:
returns:
● hasNextPart: boolean
Defined in DataModel/IPartialCollectionIterator.ts:49
Gets a value indicating whether the view has a next part available.
readonly:
returns:
● hasPreviousPart: boolean
Defined in DataModel/IPartialCollectionIterator.ts:56
Gets a value indicating whether the view has a previous part available.
readonly:
returns:
● lastPartIri: string
Defined in DataModel/IPartialCollectionIterator.ts:42
Gets the IRI to the last part.
readonly:
returns:
● nextPartIri: string
Defined in DataModel/IPartialCollectionIterator.ts:28
Gets the IRI to the next part.
readonly:
returns:
● previousPartIri: string
Defined in DataModel/IPartialCollectionIterator.ts:35
Gets the IRI to the previous part.
readonly:
returns:
▸ getFirstPart(): Promise<Iterable<IResource»
Defined in DataModel/IPartialCollectionIterator.ts:62
Retrieves a first part of the partial collection view.
Returns: Promise<Iterable<IResource»
▸ getLastPart(): Promise<Iterable<IResource»
Defined in DataModel/IPartialCollectionIterator.ts:80
Retrieves a last part of the partial collection view.
Returns: Promise<Iterable<IResource»
▸ getNextPart(): Promise<Iterable<IResource»
Defined in DataModel/IPartialCollectionIterator.ts:68
Retrieves a next part of the partial collection view.
Returns: Promise<Iterable<IResource»
▸ getPreviousPart(): Promise<Iterable<IResource»
Defined in DataModel/IPartialCollectionIterator.ts:74
Retrieves a previous part of the partial collection view.
Returns: Promise<Iterable<IResource»