public interface BlockOublietteSession extends OsidSession
This session provides methods to retrieve Block
to
Oubliette
holds. A Block
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 |
canLookupBlockOublietteMappings()
Tests if this user can perform lookups of block/oubliette holds.
|
IdList |
getBlockIdsByOubliette(Id oublietteId)
Gets the list of
Block Ids associated with a
Oubliette. |
IdList |
getBlockIdsByOubliettes(IdList oublietteIds)
Gets the list of
Block Ids corresponding to a list of
Oubliettes. |
BlockList |
getBlocksByOubliette(Id oublietteId)
Gets the list of
Blocks associated with a
Oubliette. |
BlockList |
getBlocksByOubliettes(IdList oublietteIds)
Gets the list of
Block corresponding to a list of
Oubliettes. |
IdList |
getOublietteIdsByBlock(Id blockId)
Gets the
Oubliette Ids mapped to a
Block. |
OublietteList |
getOubliettesByBlock(Id blockId)
Gets the
Oubliettes mapped to a Block. |
void |
useComparativeBlockOublietteView()
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 |
usePlenaryBlockOublietteView()
A complete view of the
Block and Oubliette
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupBlockOublietteMappings()
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 useComparativeBlockOublietteView()
mandatory
- This method is must be implemented. void usePlenaryBlockOublietteView()
Block
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 getBlockIdsByOubliette(Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Block 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. BlockList getBlocksByOubliette(Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Blocks
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 getBlockIdsByOubliettes(IdList oublietteIds) throws OperationFailedException, PermissionDeniedException
Block 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. BlockList getBlocksByOubliettes(IdList oublietteIds) throws OperationFailedException, PermissionDeniedException
Block
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 getOublietteIdsByBlock(Id blockId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Oubliette
Ids
mapped to a
Block.
blockId
- Id
of a Block
NotFoundException
- blockId
is not foundNullArgumentException
- blockId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OublietteList getOubliettesByBlock(Id blockId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Oubliettes
mapped to a Block.
blockId
- Id
of a Block
NotFoundException
- blockId
is not foundNullArgumentException
- blockId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.