module:store/PrototypeEntry

module:store/PrototypeEntry

A PrototypeEntry is used to create new entries by collecting information about the initial state of the entry to send along to the repository upon creation.

All access and utility methods from Entry is just inherited. Some methods have been moved over from EntryInformation to allow easier method chaining. Finally some information cannot be changed in an entry, e.g. the entry, graph and resource types, but are crucial before creation. Hence, some methods have been introduced to cover for this need.

Constructor

new (require("store/PrototypeEntry"))(context, id)

Source:
Parameters:
Name Type Description
context Context

where this prototypeEntry belongs.

id string

entry identifier, if not unique in the context the subsequent commit will fail.

Methods

commit() → {Promise.<Entry>}

Source:
See:
  • EntryStore#createEntry

Create a new entry according to the information specified in the prototype entry.

Returns:
Type
Promise.<Entry>

commitCachedExternalMetadata()

Source:

Allowed as a way to save cached external metadata for an entry that is assumed to exist with a given entry id.

commitMetadata()

Source:

Allowed as a way to save metadata for an entry that is assumed to exist with a given entry id.

create() → {Promise.<Entry>}

Source:
Deprecated:
  • use commit instead.
Returns:
Type
Promise.<Entry>

getParentList() → {Entry}

Source:

Get the parent list (as an entry) for this PrototypeEntry.

Returns:
Type
Entry

getResource() → {Resource}

Source:

Direct access method for the resource instance for prorotypeEntries.

Returns:
Type
Resource

getSpecificId() → {string}

Source:

Get the suggested entry id for this PrototypeEntry

Returns:
Type
string

setACL() → {PrototypeEntry}

Source:

Exposes the setACL method from EntryInfo on PrototypeEntry and makes it chainable.

Returns:
  • to allow the method call to be chained.
Type
PrototypeEntry

setEntryType() → {PrototypeEntry}

Source:

Makes it possible to change the EntryType (which is not allowed on existing entries).

Returns:
  • to allow the method call to be chained.
Type
PrototypeEntry

setExternalMetadataURI() → {PrototypeEntry}

Source:

Exposes the setExternalMetadataURI method from EntryInfo on this class and makes it chainable.

Returns:
  • to allow the method call to be chained.
Type
PrototypeEntry

setGraphType() → {PrototypeEntry}

Source:

Makes it possible to change the GraphType (which is not allowed on existing entries).

Returns:
  • to allow the method call to be chained.
Type
PrototypeEntry

setParentList(parentListEntry) → {PrototypeEntry}

Source:

When creating new entries a single parent list can be specified, hence we need a way to set it in PrototypeEntry.

Parameters:
Name Type Description
parentListEntry Entry
Returns:
  • to allow the method call to be chained.
Type
PrototypeEntry

setResourceType() → {PrototypeEntry}

Source:

Makes it possible to change the ResourceType (which is not allowed on existing entries).

Returns:
  • to allow the method call to be chained.
Type
PrototypeEntry

setResourceURI() → {PrototypeEntry}

Source:

Exposes the setResourceURI method from EntryInfo on this class and makes it chainable.

Returns:
  • to allow the method call to be chained.
Type
PrototypeEntry