OSID Logo
OSID Specifications
sequencing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.sequencing.ChainAntimatroidSession
Implementsosid.OsidSession
Description

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:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupChainAntimatroidChains
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up chains is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeChainAntimatroidView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryChainAntimatroidView
Description

A complete view of the 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.

CompliancemandatoryThis method is must be implemented.
MethodgetChainIdsByAntimatroid
Description

Gets the list of Chain Ids associated with a Antimatroid.

Parametersosid.id.IdantimatroidId Id of the Antimatroid
Returnosid.id.IdListlist of related chain Ids
ErrorsNOT_FOUND antimatroidId is not found
NULL_ARGUMENT antimatroidId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChainsByAntimatroid
Description

Gets the list of Chains associated with a Antimatroid.

Parametersosid.id.IdantimatroidId Id of the Antimatroid
Returnosid.sequencing.ChainListlist of related chains
ErrorsNOT_FOUND antimatroidId is not found
NULL_ARGUMENT antimatroidId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChainIdsByAntimatroids
Description

Gets the list of Chain Ids corresponding to a list of Antimatroids.

Parametersosid.id.IdListantimatroidIdslist of antimatroid Ids
Returnosid.id.IdListlist of chain Ids
ErrorsNULL_ARGUMENT antimatroidIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChainsByAntimatroids
Description

Gets the list of Chains corresponding to a list of Antimatroids.

Parametersosid.id.IdListantimatroidIdslist of antimatroid Ids
Returnosid.sequencing.ChainListlist of chains
ErrorsNULL_ARGUMENT antimatroidIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAntimatroidIdsByChain
Description

Gets the Antimatroid Ids mapped to a Chain.

Parametersosid.id.IdchainId Id of a Chain
Returnosid.id.IdListlist of antimatroids
ErrorsNOT_FOUND chainId is not found
NULL_ARGUMENT chainId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAntimatroidsByChain
Description

Gets the Antimatroids mapped to a Chain.

Parametersosid.id.IdchainId Id of a Chain
Returnosid.sequencing.AntimatroidListlist of antimatroids
ErrorsNOT_FOUND chainId is not found
NULL_ARGUMENT chainId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.