public interface ChainAntimatroidSession extends OsidSession
This session provides methods to retrieve Chain
to
Antimatroid
chains. A Chain
may appear in
multiple Antimatroid
objects. Each antimatroid 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 |
canLookupChainAntimatroidChains()
Tests if this user can perform lookups of chain/antimatroid mappings.
|
IdList |
getAntimatroidIdsByChain(Id chainId)
Gets the
Antimatroid Ids mapped to a
Chain. |
AntimatroidList |
getAntimatroidsByChain(Id chainId)
Gets the
Antimatroids mapped to a Chain. |
IdList |
getChainIdsByAntimatroid(Id antimatroidId)
Gets the list of
Chain Ids associated with a
Antimatroid. |
IdList |
getChainIdsByAntimatroids(IdList antimatroidIds)
Gets the list of
Chain Ids corresponding to a list of
Antimatroids. |
ChainList |
getChainsByAntimatroid(Id antimatroidId)
Gets the list of
Chains associated with a
Antimatroid. |
ChainList |
getChainsByAntimatroids(IdList antimatroidIds)
Gets the list of
Chains corresponding to a list of
Antimatroids. |
void |
useComparativeChainAntimatroidView()
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 |
usePlenaryChainAntimatroidView()
A complete view of the
Chain and Antimatroid
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupChainAntimatroidChains()
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 chains is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeChainAntimatroidView()
mandatory
- This method is must be implemented. void usePlenaryChainAntimatroidView()
Chain
and Antimatroid
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 getChainIdsByAntimatroid(Id antimatroidId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Chain Ids
associated with a
Antimatroid.
antimatroidId
- Id
of the Antimatroid
Ids
NotFoundException
- antimatroidId
is not
foundNullArgumentException
- antimatroidId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ChainList getChainsByAntimatroid(Id antimatroidId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Chains
associated with a
Antimatroid.
antimatroidId
- Id
of the Antimatroid
NotFoundException
- antimatroidId
is not
foundNullArgumentException
- antimatroidId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getChainIdsByAntimatroids(IdList antimatroidIds) throws OperationFailedException, PermissionDeniedException
Chain Ids
corresponding to a list of
Antimatroids.
antimatroidIds
- list of antimatroid Ids
Ids
NullArgumentException
- antimatroidIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ChainList getChainsByAntimatroids(IdList antimatroidIds) throws OperationFailedException, PermissionDeniedException
Chains
corresponding to a list of
Antimatroids.
antimatroidIds
- list of antimatroid Ids
NullArgumentException
- antimatroidIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getAntimatroidIdsByChain(Id chainId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Antimatroid
Ids
mapped to a
Chain.
chainId
- Id
of a Chain
NotFoundException
- chainId
is not foundNullArgumentException
- chainId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AntimatroidList getAntimatroidsByChain(Id chainId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Antimatroids
mapped to a Chain.
chainId
- Id
of a Chain
NotFoundException
- chainId
is not foundNullArgumentException
- chainId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.