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

This session provides methods to add and remove elements from 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.
MethodcanManageElements
Description

Tests if this user can add and remove 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 managing elements is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaddElement
Description

Adds an element to a chain,

Parametersosid.id.IdchainIdthe Id of the chain
osid.id.Ididthe Id of the element to add
ErrorsALREADY_EXISTS id already in chainId
NOT_FOUND chainId or id not found
NULL_ARGUMENT chainId or id is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddElements
Description

Adds a list of ordered elements to a chain.

Parametersosid.id.IdchainIdthe Id of the chain
osid.id.IdListidsthe Ids of the elements to add
ErrorsALREADY_EXISTSan id already in chainId
NOT_FOUND chainId or an id not found
NULL_ARGUMENT chainIds or id is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveElement
Description

Removes an element from a chain.

Parametersosid.id.IdchainIdthe Id of the chain
osid.id.Ididthe Id of the element to remove
ErrorsNOT_FOUND chainId or id not found, or id is not in chainId
NULL_ARGUMENT chainId or id is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.