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

This session provides methods to get the sequence of elements in a Chain.

MethodgetAntimatroidId
Description

Gets the Antimatroid Id associated with this session.

Returnosid.id.Idthe Antimatroid Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAntimatroid
Description

Gets the Antimatroid associated with this session.

Returnosid.sequencing.Antimatroidthe antimatroid
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupElements
Description

Tests if this user can lookup eleemnts to a chain. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returnboolean false if looking up elements is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetElements
Description

Gets the ordered list of elements from a Chain.

Parametersosid.id.IdchainIdthe Id of the chain
ErrorsNOT_FOUND chainId not found
NULL_ARGUMENT chainId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.