public interface ResourceRelationshipBinSession extends OsidSession
This session provides methods to retrieve ResourceRelationship
to Bin
mappings. A Resource
may
appear in multiple Bins.
Each Bin
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 |
canLookupResourceRelationshipBinMappings()
Tests if this user can perform lookups of resource relationship/bin
mappings.
|
IdList |
getBinIdsByResourceRelationship(Id resourceRelationshipId)
Gets the list of
Bin Ids mapped to a
ResourceRelationship. |
BinList |
getBinsByResourceRelationship(Id resourceRelationshipId)
Gets the list of
Bin objects mapped to a
ResourceRelationship. |
IdList |
getResourceRelationshipIdsByBin(Id binId)
Gets the list of
ResourceRelationship Ids
associated with a Bin. |
ResourceRelationshipList |
getResourceRelationshipsByBin(Id binId)
Gets the list of
ResourceRelationships associated with
a Bin. |
ResourceRelationshipList |
getResourceRelationshipsByBins(IdList binIds)
Gets the list of
ResourceRelationships corresponding to
a list of Bins. |
IdList |
getResourceRelationshipsIdsByBins(IdList binIds)
Gets the list of
ResourceRelationship Ids corresponding
to a list of Bin objects. |
void |
useComparativeBinView()
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 |
usePlenaryBinView()
A complete view of the
Resource and Bin
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
void useComparativeBinView()
mandatory
- This method is must be implemented. void usePlenaryBinView()
Resource
and Bin
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. boolean canLookupResourceRelationshipBinMappings()
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. IdList getResourceRelationshipIdsByBin(Id binId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ResourceRelationship
Ids
associated with a Bin.
binId
- Id
of a Bin
Ids
NotFoundException
- binId
is not foundNullArgumentException
- binId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResourceRelationshipList getResourceRelationshipsByBin(Id binId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ResourceRelationships
associated with
a Bin.
binId
- Id
of a Bin
NotFoundException
- binId
is not foundNullArgumentException
- binId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getResourceRelationshipsIdsByBins(IdList binIds) throws OperationFailedException, PermissionDeniedException
ResourceRelationship Ids
corresponding
to a list of Bin
objects.binIds
- list of bin Ids
Ids
NullArgumentException
- binIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ResourceRelationshipList getResourceRelationshipsByBins(IdList binIds) throws OperationFailedException, PermissionDeniedException
ResourceRelationships
corresponding to
a list of Bins.
binIds
- list of bin Ids
NullArgumentException
- binIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getBinIdsByResourceRelationship(Id resourceRelationshipId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Bin
Ids
mapped to a
ResourceRelationship.
resourceRelationshipId
- Id
of a
ResourceRelationship
Ids
NotFoundException
- resourceRelationshipId
is not foundNullArgumentException
- resourceRelationshipId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BinList getBinsByResourceRelationship(Id resourceRelationshipId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Bin
objects mapped to a
ResourceRelationship.
resourceRelationshipId
- Id
of a
ResourceRelationship
NotFoundException
- resourceRelationshipId
is not foundNullArgumentException
- resourceRelationshipId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.