public interface HoldEnablerOublietteSession extends OsidSession
This session provides methods to retrieve HoldEnabler
to
Hold
mappings. A HoldEnabler
may appear in
multiple Hold
objects. Each hold may have its own
authorizations governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupHoldEnablerOubliettetMappings()
Tests if this user can perform lookups of hold enabler/oubliette
mappings.
|
IdList |
getHoldEnablerIdsByOubliette(Id oublietteId)
Gets the list of
HoldEnablerIds associated with a
Oubliette. |
IdList |
getHoldEnablerIdsByOubliettes(IdList oublietteIds)
Gets the list of
HoldEnabler Ids corresponding to a
list of Oubliettes. |
HoldEnablerList |
getHoldEnablersByOubliette(Id oublietteId)
Gets the list of hold enablers associated with a
Oubliette. |
HoldEnablerList |
getHoldEnablersByOubliettes(IdList oublietteIds)
Gets the list of hold enablers corresponding to a list of
Oubliettes. |
OublietteList |
getHoldsByHoldEnabler(Id holdEnablerId)
Gets the oubliettes mapped to a
HoldEnabler. |
IdList |
getOublietteIdsByHoldEnabler(Id holdEnablerId)
Gets the
Oubliette Ids mapped to a
HoldEnabler. |
void |
useComparativeHoldEnablerOublietteView()
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 |
usePlenaryHoldEnablerOublietteView()
A complete view of the
HoldEnabler and Oubliette
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupHoldEnablerOubliettetMappings()
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 useComparativeHoldEnablerOublietteView()
mandatory
- This method is must be implemented. void usePlenaryHoldEnablerOublietteView()
HoldEnabler
and Oubliette
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. IdList getHoldEnablerIdsByOubliette(Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
HoldEnablerIds
associated with a
Oubliette.
oublietteId
- Id
of the Oubliette
Ids
NotFoundException
- oublietteId
is not
foundNullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. HoldEnablerList getHoldEnablersByOubliette(Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Oubliette.
oublietteId
- Id
of the Oubliette
NotFoundException
- oublietteId
is not
foundNullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getHoldEnablerIdsByOubliettes(IdList oublietteIds) throws OperationFailedException, PermissionDeniedException
HoldEnabler Ids
corresponding to a
list of Oubliettes.
oublietteIds
- list of oubliette Ids
Ids
NullArgumentException
- oublietteIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. HoldEnablerList getHoldEnablersByOubliettes(IdList oublietteIds) throws OperationFailedException, PermissionDeniedException
Oubliettes.
oublietteIds
- list of oubliette Ids
NullArgumentException
- oublietteIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getOublietteIdsByHoldEnabler(Id holdEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Oubliette
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. OublietteList getHoldsByHoldEnabler(Id holdEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.