public interface HoldEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve HoldEnabler
to
Hold
mappings. A Hold
with multiple
HoldEnablers
means any positive rule evaluation across the
enablers result in an enabled Hold.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupHoldEnablerRules()
Tests if this user can perform lookups of hold enabler/hold mappings.
|
IdList |
getHoldEnablerIdsForHold(Id holdId)
Gets the
HoldEnabler Id associated with a Hold. |
HoldEnablerList |
getHoldEnablersForHold(Id holdId)
Gets the
HoldEnabler associated with a Hold. |
IdList |
getHoldIdsByHoldEnabler(Id holdEnablerId)
Gets the
Hold Ids mapped to a
HoldEnabler. |
HoldList |
getHoldsByHoldEnabler(Id holdEnablerId)
Gets the
Holds mapped to a HoldEnabler. |
Oubliette |
getOubliette()
Gets the
Oubliette associated with this session. |
Id |
getOublietteId()
Gets the
Oubliette Id associated with
this session. |
void |
useComparativeHoldEnablerRuleView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedOublietteView()
Federates the view for methods in this session.
|
void |
useIsolatedOublietteView()
Isolates the view for methods in this session.
|
void |
usePlenaryHoldEnablerRuleView()
A complete view of the
HoldEnabler and Hold
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getOublietteId()
Oubliette
Id
associated with
this session. Oubliette Id
associated with this sessionmandatory
- This method must be implemented. Oubliette getOubliette() throws OperationFailedException, PermissionDeniedException
Oubliette
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupHoldEnablerRules()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeHoldEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryHoldEnablerRuleView()
HoldEnabler
and Hold
returns is desired. Methods will return what is requested or
result in an error. This view is used when greater precision is
desired at the expense of interoperability.mandatory
- This method is must be implemented. void useFederatedOublietteView()
mandatory
- This method is must be implemented. void useIsolatedOublietteView()
mandatory
- This method is must be implemented. IdList getHoldEnablerIdsForHold(Id holdId) throws NotFoundException, OperationFailedException, PermissionDeniedException
HoldEnabler Id
associated with a Hold.
holdId
- Id
of the Hold
Ids
NotFoundException
- holdId
is not foundNullArgumentException
- holdId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. HoldEnablerList getHoldEnablersForHold(Id holdId) throws NotFoundException, OperationFailedException, PermissionDeniedException
HoldEnabler
associated with a Hold.
holdId
- Id
of the Hold
NotFoundException
- holdId
is not foundNullArgumentException
- holdId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getHoldIdsByHoldEnabler(Id holdEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Hold
Ids
mapped to a
HoldEnabler.
holdEnablerId
- Id
of a HoldEnabler
Ids
NotFoundException
- holdEnablerId
is not
foundNullArgumentException
- holdEnablerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. HoldList getHoldsByHoldEnabler(Id holdEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Holds
mapped to a HoldEnabler.
holdEnablerId
- Id
of a HoldEnabler
NotFoundException
- holdEnablerId
is not
foundNullArgumentException
- holdEnablerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.