public interface HoldOublietteSession extends OsidSession
This session provides methods to retrieve Hold
to
Oubliette
mappings. A Hold
may appear in multiple
Oubliette
objects. Each oubliette 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 |
canLookupHoldOublietteMappings()
Tests if this user can perform lookups of hold/oubliette mappings.
|
IdList |
getHoldIdsByOubliette(Id oublietteId)
Gets the list of
Hold Ids associated with a
Oubliette. |
IdList |
getHoldIdsByOubliettes(IdList oublietteIds)
Gets the list of
Hold Ids corresponding to a list of
Oubliettes. |
HoldList |
getHoldsByOubliette(Id oublietteId)
Gets the list of
Holds associated with a
Oubliette. |
HoldList |
getHoldsByOubliettes(IdList oublietteIds)
Gets the list of
Hold corresponding to a list of
Oubliettes. |
OublietteList |
getOublietteByHold(Id holdId)
Gets the
Oubliettes mapped to a Hold. |
IdList |
getOublietteIdsByHold(Id holdId)
Gets the
Oubliette Ids mapped to a
Hold. |
void |
useComparativeHoldOublietteView()
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 |
usePlenaryHoldOublietteView()
A complete view of the
Hold and Oubliette
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupHoldOublietteMappings()
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 useComparativeHoldOublietteView()
mandatory
- This method is must be implemented. void usePlenaryHoldOublietteView()
Hold
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 getHoldIdsByOubliette(Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Hold Ids
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. HoldList getHoldsByOubliette(Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Holds
associated with a
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 getHoldIdsByOubliettes(IdList oublietteIds) throws OperationFailedException, PermissionDeniedException
Hold 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. HoldList getHoldsByOubliettes(IdList oublietteIds) throws OperationFailedException, PermissionDeniedException
Hold
corresponding to a list of
Oubliettes.
oublietteIds
- list of oubliette Ids
NullArgumentException
- oublietteIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getOublietteIdsByHold(Id holdId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Oubliette
Ids
mapped to a
Hold.
holdId
- Id
of a Hold
NotFoundException
- holdId
is not foundNullArgumentException
- holdId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OublietteList getOublietteByHold(Id holdId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Oubliettes
mapped to a Hold.
holdId
- Id
of a Hold
NotFoundException
- holdId
is not foundNullArgumentException
- holdId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.