Interface | osid.sequencing.ElementAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to add and remove elements from a chain. | ||
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 | canManageElements | ||
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 | ||
Return | boolean | false if managing elements is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | addElement | ||
Description |
Adds an element to a chain, | ||
Parameters | osid.id.Id | chainId | the Id of the chain |
osid.id.Id | id | the Id of the element to add | |
Errors | ALREADY_EXISTS | id already in chainId | |
NOT_FOUND | chainId or id not found | ||
NULL_ARGUMENT | chainId or id is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addElements | ||
Description |
Adds a list of ordered elements to a chain. | ||
Parameters | osid.id.Id | chainId | the Id of the chain |
osid.id.IdList | ids | the Ids of the elements to add | |
Errors | ALREADY_EXISTS | an id already in chainId | |
NOT_FOUND | chainId or an id not found | ||
NULL_ARGUMENT | chainIds or id is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeElement | ||
Description |
Removes an element from a chain. | ||
Parameters | osid.id.Id | chainId | the Id of the chain |
osid.id.Id | id | the Id of the element to remove | |
Errors | NOT_FOUND | chainId or id not found, or id
is not in chainId | |
NULL_ARGUMENT | chainId or id is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |