Interface AtomicResourceStore

A ResourceStore of which all operations are atomic.

Hierarchy

ResourceStore
- AtomicResourceStore

Implemented by

LockingResourceStore

Index

Properties

addResource deleteResource getRepresentation hasResource modifyResource setRepresentation

Properties

addResource

addResource: ((container: ResourceIdentifier, representation: Representation, conditions?: Conditions) => Promise<ResourceIdentifier>)

Type declaration

- (container: ResourceIdentifier, representation: Representation, conditions?: Conditions): Promise<ResourceIdentifier>
- Creates a new resource in the container.
  
  Returns
  The identifier of the newly created resource.
  Parameters
  - container: ResourceIdentifier
    
    Container in which to create a resource.
  - representation: Representation
    
    Representation of the new resource
  - Optional conditions: Conditions
    
    Optional conditions under which to proceed.
  Returns Promise<ResourceIdentifier>

deleteResource

deleteResource: ((identifier: ResourceIdentifier, conditions?: Conditions) => Promise<ResourceIdentifier[]>)

Type declaration

- (identifier: ResourceIdentifier, conditions?: Conditions): Promise<ResourceIdentifier[]>
- Deletes a resource.
  
  Returns
  Identifiers of resources that were possibly modified.
  Parameters
  - identifier: ResourceIdentifier
    
    Identifier of resource to delete.
  - Optional conditions: Conditions
    
    Optional conditions under which to proceed.
  Returns Promise<ResourceIdentifier[]>

getRepresentation

getRepresentation: ((identifier: ResourceIdentifier, preferences: RepresentationPreferences, conditions?: Conditions) => Promise<Representation>)

Type declaration

- (identifier: ResourceIdentifier, preferences: RepresentationPreferences, conditions?: Conditions): Promise<Representation>
- Retrieves a representation of a resource.
  
  Returns
  A representation corresponding to the identifier.
  Parameters
  - identifier: ResourceIdentifier
    
    Identifier of the resource to read.
  - preferences: RepresentationPreferences
    
    Preferences indicating desired representations.
  - Optional conditions: Conditions
    
    Optional conditions under which to proceed.
  Returns Promise<Representation>

hasResource

hasResource: ((identifier: ResourceIdentifier) => Promise<boolean>)

Type declaration

- (identifier: ResourceIdentifier): Promise<boolean>
- Check if a resource exists in this ResourceSet.
  
  Returns
  A promise resolving if the resource already exists.
  Parameters
  - identifier: ResourceIdentifier
    
    Identifier of resource to check.
  Returns Promise<boolean>

modifyResource

modifyResource: ((identifier: ResourceIdentifier, patch: Patch, conditions?: Conditions) => Promise<ResourceIdentifier[]>)

Type declaration

- (identifier: ResourceIdentifier, patch: Patch, conditions?: Conditions): Promise<ResourceIdentifier[]>
- Sets or updates the representation of a resource, creating a new resource and intermediary containers as needed.
  
  Returns
  Identifiers of resources that were possibly modified.
  Parameters
  - identifier: ResourceIdentifier
    
    Identifier of resource to update.
  - patch: Patch
    
    Description of which parts to update.
  - Optional conditions: Conditions
    
    Optional conditions under which to proceed.
  Returns Promise<ResourceIdentifier[]>

setRepresentation

setRepresentation: ((identifier: ResourceIdentifier, representation: Representation, conditions?: Conditions) => Promise<ResourceIdentifier[]>)

Type declaration

- (identifier: ResourceIdentifier, representation: Representation, conditions?: Conditions): Promise<ResourceIdentifier[]>
- Sets or replaces the representation of a resource, creating a new resource and intermediary containers as needed.
  
  Returns
  Identifiers of resources that were possibly modified.
  Parameters
  - identifier: ResourceIdentifier
    
    Identifier of resource to update.
  - representation: Representation
    
    New representation of the resource.
  - Optional conditions: Conditions
    
    Optional conditions under which to proceed.
  Returns Promise<ResourceIdentifier[]>

Interface AtomicResourceStore

Hierarchy

Implemented by

Index

Properties

Properties

addResource

Type declaration

Returns

Parameters

container: ResourceIdentifier

representation: Representation

Optional conditions: Conditions

Returns Promise<ResourceIdentifier>

deleteResource

Type declaration

Returns

Parameters

identifier: ResourceIdentifier

Optional conditions: Conditions

Returns Promise<ResourceIdentifier[]>

getRepresentation

Type declaration

Returns

Parameters

identifier: ResourceIdentifier

preferences: RepresentationPreferences

Optional conditions: Conditions

Returns Promise<Representation>

hasResource

Type declaration

Returns

Parameters

identifier: ResourceIdentifier

Returns Promise<boolean>

modifyResource

Type declaration

Returns

Parameters

identifier: ResourceIdentifier

patch: Patch

Optional conditions: Conditions

Returns Promise<ResourceIdentifier[]>

setRepresentation

Type declaration

Returns

Parameters

identifier: ResourceIdentifier

representation: Representation

Optional conditions: Conditions

Returns Promise<ResourceIdentifier[]>

Settings

Member Visibility

Theme

`Optional` conditions: Conditions

`Optional` conditions: Conditions

`Optional` conditions: Conditions

`Optional` conditions: Conditions

`Optional` conditions: Conditions