public interface HoldEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply HoldEnablers
to
Holds.
A Hold
with multiple
HoldEnablers
means any positive rule evaluation across the
enablers result in an effective Hold.
Modifier and Type | Method and Description |
---|---|
void |
assignHoldEnablerToHold(Id holdEnablerId,
Id holdId)
Adds an existing
HoldEnabler to a Hold. |
boolean |
canAssignHoldEnablers()
Tests if this user can alter hold enabler/hold mappings.
|
boolean |
canSequenceHoldEnablers()
Tests if this user can order
HoldEnablers. |
Oubliette |
getOubliette()
Gets the
Oubliette associated with this session. |
Id |
getOublietteId()
Gets the
Oubliette Id associated with
this session. |
void |
moveHoldEnablerAhead(Id holdEnablerId,
Id holdId,
Id referenceId)
Reorders hold enablers for a hold by moving the specified hold enabler
in front of a reference hold enabler.
|
void |
moveHoldEnablerBehind(Id holdEnablerId,
Id holdId,
Id referenceId)
Reorders hold enablers for a hold by moving the specified hold enabler
behind a reference hold enabler.
|
void |
orderHoldEnablers(Id[] holdEnablerId,
Id holdId)
Reorders a set of hold enablers for a hold.
|
void |
unassignHoldEnablerFromHold(Id holdEnablerId,
Id holdId)
Removes a
HoldEnabler from a Hold. |
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 canAssignHoldEnablers()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. void assignHoldEnablerToHold(Id holdEnablerId, Id holdId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
HoldEnabler
to a Hold.
holdEnablerId
- the Id
of the HoldEnabler
holdId
- the Id
of the Hold
AlreadyExistsException
- holdEnablerId
is already applied to holdId
NotFoundException
- holdEnablerId
or
holdId
not foundNullArgumentException
- holdEnablerId
or
holdId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignHoldEnablerFromHold(Id holdEnablerId, Id holdId) throws NotFoundException, OperationFailedException, PermissionDeniedException
HoldEnabler
from a Hold.
holdEnablerId
- the Id
of the HoldEnabler
holdId
- the Id
of the Hold
NotFoundException
- holdEnablerId
or
holdId
not found or holdEnablerId
is not applied to holdId
NullArgumentException
- holdEnablerId
or
holdId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceHoldEnablers()
HoldEnablers.
A return of
true does not guarantee successful authorization. A return of false
indicates that it is known sequencing operations will result in a
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer sequencing operations to an
unauthorized user. false
if HoldEnabler
ordering is
not authorized, true
otherwisemandatory
- This method must be implemented. void moveHoldEnablerAhead(Id holdEnablerId, Id holdId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
holdEnablerId
- the Id
of a HoldEnabler
holdId
- the Id
of a Hold
referenceId
- the reference hold enabler Id
NotFoundException
- holdEnablerId, holdId,
or referenceId
not found or,
holdEnablerId
or referenceId
not
related to holdId
NullArgumentException
- holdEnablerId, holdId,
or referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveHoldEnablerBehind(Id holdEnablerId, Id holdId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
holdEnablerId
- the Id
of a HoldEnabler
holdId
- the Id
of a Hold
referenceId
- the reference hold enabler Id
NotFoundException
- holdEnablerId, holdId,
or referenceId
not found or,
holdEnablerId
or referenceId
not
related to holdId
NullArgumentException
- holdEnablerId, holdId,
or referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderHoldEnablers(Id[] holdEnablerId, Id holdId) throws NotFoundException, OperationFailedException, PermissionDeniedException
holdEnablerId
- the Ids
for a set of
HoldEnablers
holdId
- the Id
of a Hold
NotFoundException
- holdId
not found or,
a holdnEnablerId
not related to holdId
NullArgumentException
- holdEnablerIds
or holdId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.