OSID Specifications
sequencing package
Version 3.1.0
sequencing package
Version 3.1.0
| Interface | osid.sequencing.AntimatroidHierarchyDesignSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.sequencing.SequencingManager | ||
osid.sequencing.SequencingProxyManager | |||
| Description |
This session defines methods for managing a hierarchy of
| ||
| Method | getAntimatroidHierarchyId | ||
| Description |
Gets the hierarchy | ||
| Return | osid.id.Id | the hierarchy Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAntimatroidHierarchy | ||
| Description |
Gets the hierarchy associated with this session. | ||
| Return | osid.hierarchy.Hierarchy | the hierarchy associated with this session | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canModifyAntimatroidHierarchy | ||
| Description |
Tests if this user can change the hierarchy. 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 changing this hierarchy is not authorized,
true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | addRootAntimatroid | ||
| Description |
Adds a root antimatroid. | ||
| Parameters | osid.id.Id | antimatroidId | the Id of an antimatroid |
| Errors | ALREADY_EXISTS | antimatroidId is already in hierarchy | |
| NOT_FOUND | antimatroidId not found | ||
| NULL_ARGUMENT | antimatroidId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeRootAntimatroid | ||
| Description |
Removes a root antimatroid. | ||
| Parameters | osid.id.Id | antimatroidId | the Id of an antimatroid |
| Errors | NOT_FOUND | antimatroidId is not a root | |
| NULL_ARGUMENT | antimatroidId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | addChildAntimatroid | ||
| Description |
Adds a child to an antimatroid. | ||
| Parameters | osid.id.Id | antimatroidId | the Id of an antimatroid |
osid.id.Id | childId | the Id of the new child | |
| Errors | ALREADY_EXISTS | antimatroidId is already a parent of childId | |
| NOT_FOUND | antimatroidId or childId not found | ||
| NULL_ARGUMENT | antimatroidId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildAntimatroid | ||
| Description |
Removes a child from an antimatroid. | ||
| Parameters | osid.id.Id | antimatroidId | the Id of an antimatroid |
osid.id.Id | childId | the Id of the new child | |
| Errors | NOT_FOUND | antimatroidId is not parent of childId | |
| NULL_ARGUMENT | antimatroidId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildAntimatroids | ||
| Description |
Removes all children from an antimatroid. | ||
| Parameters | osid.id.Id | antimatroidId | the Id of an antimatroid |
| Errors | NOT_FOUND | antimatroidId is not found | |
| NULL_ARGUMENT | antimatroidId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |