Interface | osid.sequencing.ChainAntimatroidSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupChainAntimatroidChains | ||
Description |
Tests if this user can perform lookups of
chain/antimatroid mappings. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known lookup methods in this session
will result in a | ||
Return | boolean | false if looking up chains is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeChainAntimatroidView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryChainAntimatroidView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getChainIdsByAntimatroid | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | antimatroidId | Id of the Antimatroid |
Return | osid.id.IdList | list of related chain Ids | |
Errors | NOT_FOUND | antimatroidId is not found | |
NULL_ARGUMENT | antimatroidId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getChainsByAntimatroid | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | antimatroidId | Id of the Antimatroid |
Return | osid.sequencing.ChainList | list of related chains | |
Errors | NOT_FOUND | antimatroidId is not found | |
NULL_ARGUMENT | antimatroidId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getChainIdsByAntimatroids | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | antimatroidIds | list of antimatroid Ids |
Return | osid.id.IdList | list of chain Ids | |
Errors | NULL_ARGUMENT | antimatroidIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getChainsByAntimatroids | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | antimatroidIds | list of antimatroid Ids |
Return | osid.sequencing.ChainList | list of chains | |
Errors | NULL_ARGUMENT | antimatroidIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAntimatroidIdsByChain | ||
Description |
Gets the | ||
Parameters | osid.id.Id | chainId | Id of a Chain |
Return | osid.id.IdList | list of antimatroids | |
Errors | NOT_FOUND | chainId is not found | |
NULL_ARGUMENT | chainId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAntimatroidsByChain | ||
Description |
Gets the | ||
Parameters | osid.id.Id | chainId | Id of a Chain |
Return | osid.sequencing.AntimatroidList | list of antimatroids | |
Errors | NOT_FOUND | chainId is not found | |
NULL_ARGUMENT | chainId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |