de.espirit.firstspirit.agency

Interface StoreElementAgent

public interface StoreElementAgent

Definition for an agent offering direct access to store elements by referencing information.

Example:
SpecialistsBroker.requireSpecialist(StoreElementAgent.TYPE)

Since:

4.2.405

Field Summary

Fields

Modifier and Type	Field and Description
static SpecialistType<StoreElementAgent>	TYPE The specialized agent's type to be used for requesting the agent from a SpecialistsBroker.

Method Summary

Methods

Modifier and Type	Method and Description
Referenceable	loadReference(String reference, boolean release) Load a reference with the given reference descriptor.
IDProvider	loadStoreElement(String uid, IDProvider.UidType uidType, boolean release) Load a media object with the given uid and uidType.

Field Detail

TYPE

static final SpecialistType<StoreElementAgent> TYPE

The specialized agent's type to be used for requesting the agent from a SpecialistsBroker.

Since:

4.2.405

Method Detail

loadStoreElement

@Nullable
IDProvider loadStoreElement(@NotNull
                                   String uid,
                                   @NotNull
                                   IDProvider.UidType uidType,
                                   boolean release)
                            throws de.espirit.firstspirit.store.access.AccessDeniedException

Load a media object with the given uid and uidType.

Parameters:

uid - The uid of the requested object.

uidType - The type of the requested object.

release - Indicator for loading objects being released, true, or current, false.

Returns:

The loaded object or null, if the object is not available.

Throws:

de.espirit.firstspirit.store.access.AccessDeniedException - If access to the requested element has been denied.

Since:

4.2.405

loadReference

@Nullable
Referenceable loadReference(@NotNull
                                   String reference,
                                   boolean release)

Load a reference with the given reference descriptor.

Parameters:

reference - The reference descriptor of the requested object.

release - Indicator for loading objects being released, true, or current, false.

Returns:

The loaded reference or null, if the object is not available.

Since:

4.2.405