Package 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
Modifier and TypeFieldDescriptionstatic final SpecialistType<StoreElementAgent>
The specialized agent's type to be used for requesting the agent from aSpecialistsBroker
. -
Method Summary
Modifier and TypeMethodDescription@Nullable Referenceable
loadReference
(@NotNull String reference, boolean release) Load a reference with the given reference descriptor.@Nullable IDProvider
loadStoreElement
(@NotNull String uid, IDProvider.UidType uidType, boolean release) Load a store object with the givenuid
anduidType
.
-
Field Details
-
TYPE
The specialized agent's type to be used for requesting the agent from aSpecialistsBroker
.- Since:
- 4.2.405
-
-
Method Details
-
loadStoreElement
@Nullable @Nullable IDProvider loadStoreElement(@NotNull @NotNull String uid, @NotNull IDProvider.UidType uidType, boolean release) throws AccessDeniedException Load a store object with the givenuid
anduidType
.- 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:
AccessDeniedException
- If access to the requested element has been denied.- Since:
- 4.2.405
-
loadReference
@Nullable @Nullable Referenceable loadReference(@NotNull @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
-