OSID Specifications
lexicon package
Version 3.0.0
lexicon package
Version 3.0.0
| Interface | osid.lexicon.PressHierarchyDesignSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.lexicon.LexiconManager | ||
osid.lexicon.LexiconProxyManager | |||
| Description |
This session defines methods for managing a hierarchy of
| ||
| Method | getPressHierarchyId | ||
| Description |
Gets the hierarchy | ||
| Return | osid.id.Id | the hierarchy Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPressHierarchy | ||
| 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 | canModifyPressHierarchy | ||
| 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 | addRootPress | ||
| Description |
Adds a root press. | ||
| Parameters | osid.id.Id | pressId | the Id of an press |
| Errors | ALREADY_EXISTS | pressId is already in hierarchy | |
| NOT_FOUND | pressId not found | ||
| NULL_ARGUMENT | pressId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeRootPress | ||
| Description |
Removes a root press. | ||
| Parameters | osid.id.Id | pressId | the Id of an press |
| Errors | NOT_FOUND | pressId is not a root | |
| NULL_ARGUMENT | pressId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | addChildPress | ||
| Description |
Adds a child to an press. | ||
| Parameters | osid.id.Id | pressId | the Id of an press |
osid.id.Id | childId | the Id of the new child | |
| Errors | ALREADY_EXISTS | pressId is already a parent of childId | |
| NOT_FOUND | pressId or childId not found | ||
| NULL_ARGUMENT | pressId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildPress | ||
| Description |
Removes a child from an press. | ||
| Parameters | osid.id.Id | pressId | the Id of an press |
osid.id.Id | childId | the Id of the new child | |
| Errors | NOT_FOUND | pressId is not parent of childId | |
| NULL_ARGUMENT | pressId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildPresses | ||
| Description |
Removes all children from an press. | ||
| Parameters | osid.id.Id | pressId | the Id of an press |
| Errors | NOT_FOUND | pressId is not found | |
| NULL_ARGUMENT | pressId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |