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

This session provides methods to sequence the 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.
MethodcanSequence
Description

Tests if this user can sequence things. 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 sequencing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveElementAhead
Description

Moves an element ahead of a reference element in a chain.

Parametersosid.id.IdchainIdthe Id of the chain
osid.id.IdreferenceIdthe Id of the reference element
osid.id.Ididthe Id of the element to move ahead of referenceId
ErrorsNOT_FOUND chainId, referenceId, or id not found, or referenceId or id is not related to chainId
NULL_ARGUMENT chainId, referenceId, or id is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveElementBehind
Description

Moves an element beind a reference element in a chain.

Parametersosid.id.IdchainIdthe Id of the chain
osid.id.IdreferenceIdthe Id of the reference element
osid.id.Ididthe Id of the element to move behind of referenceId
ErrorsNOT_FOUND parentId, referenceId, or id not found, or referenceId or id is not a child of parentId
NULL_ARGUMENT chainId, referenceId, or id is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodsequenceElements
Description

Sequences a set of elements in a chain.

Parametersosid.id.IdchainIdthe Id of the chain
osid.id.Id[]idsthe Id of the elements
ErrorsNOT_FOUND chainId or an id not found, or an id is not related to chainId
NULL_ARGUMENT chainId or ids is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.