OSID Specifications
sequencing package
Version 3.0.0
sequencing package
Version 3.0.0
| Interface | osid.sequencing.SequencingSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.sequencing.SequencingManager | ||
osid.sequencing.SequencingProxyManager | |||
| Description |
This session provides methods to sequence the elements in a
| ||
| Method | getAntimatroidId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the Antimatroid Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAntimatroid | ||
| Description |
Gets the | ||
| Return | osid.sequencing.Antimatroid | the antimatroid | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canSequence | ||
| 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 | ||
| Return | boolean | false if sequencing is not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | moveElementAhead | ||
| Description |
Moves an element ahead of a reference element in a chain. | ||
| Parameters | osid.id.Id | chainId | the Id of the chain |
osid.id.Id | referenceId | the Id of the reference element | |
osid.id.Id | id | the Id of the element to move ahead of
referenceId | |
| Errors | NOT_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_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | moveElementBehind | ||
| Description |
Moves an element beind a reference element in a chain. | ||
| Parameters | osid.id.Id | chainId | the Id of the chain |
osid.id.Id | referenceId | the Id of the reference element | |
osid.id.Id | id | the Id of the element to move behind of
referenceId | |
| Errors | NOT_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_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | sequenceElements | ||
| Description |
Sequences a set of elements in a chain. | ||
| Parameters | osid.id.Id | chainId | the Id of the chain |
osid.id.Id[] | ids | the Id of the elements | |
| Errors | NOT_FOUND | chainId or an id not found, or an id
is not related to chainId | |
| NULL_ARGUMENT | chainId or ids is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |