| Interface | osid.sequencing.ChainAntimatroidAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of a | ||
| Method | canAssignChains | ||
| Description |
Tests if this user can alter chain/antimatroid
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
| Return | boolean | false if chain is not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignChainsToAntimatroid | ||
| Description |
Tests if this user can alter chain/antimatroid
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
| Parameters | osid.id.Id | antimatroidId | the Id of the Antimatroid |
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Errors | NULL_ARGUMENT | antimatroidId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableAntimatroidIds | ||
| Description |
Gets a list of antimatroids including and under the given antimatroid node in which any chain can be assigned. | ||
| Parameters | osid.id.Id | antimatroidId | the Id of the Antimatroid |
| Return | osid.id.IdList | list of assignable antimatroid Ids | |
| Errors | NULL_ARGUMENT | antimatroidId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableAntimatroidIdsForChain | ||
| Description |
Gets a list of antimatroids including and under the given antimatroid node in which a specific chain can be assigned. | ||
| Parameters | osid.id.Id | antimatroidId | the Id of the Antimatroid |
osid.id.Id | chainId | the Id of the Chain | |
| Return | osid.id.IdList | list of assignable antimatroid Ids | |
| Errors | NULL_ARGUMENT | antimatroidId or chainId is null
| |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignChainToAntimatroid | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | chainId | the Id of the Chain |
osid.id.Id | antimatroidId | the Id of the Antimatroid | |
| Errors | ALREADY_EXISTS | chainId is already assigned to antimatroidId | |
| NOT_FOUND | chainId or antimatroidId not found | ||
| NULL_ARGUMENT | chainId or antimatroidId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignChainFromAntimatroid | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | chainId | the Id of the Chain |
osid.id.Id | antimatroidId | the Id of the Antimatroid | |
| Errors | NOT_FOUND | chainId or antimatroidId not found or
chainId not assigned to antimatroidId | |
| NULL_ARGUMENT | chainId or antimatroidId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignChainToAntimatroid | ||
| Description |
Moves a | ||
| Parameters | osid.id.Id | chainId | the Id of the Chain |
osid.id.Id | fromAntimatroidId | the Id of the current Antimatroid | |
osid.id.Id | toAntimatroidId | the Id of the destination Antimatroid | |
| Errors | NOT_FOUND | chainId, fromAntimatroidId, or toAntimatroidId
not found or chainId not mapped to
fromAntimatroidId | |
| NULL_ARGUMENT | chainId, fromAntimatroidId, or toAntimatroidId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |