OSID Specifications
tracking package
Version 3.1.0
tracking package
Version 3.1.0
| Interface | osid.tracking.FrontOfficeHierarchyDesignSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.tracking.TrackingManager | ||
osid.tracking.TrackingProxyManager | |||
| Description |
This session defines methods for managing a hierarchy of
| ||
| Method | getFrontOfficeHierarchyId | ||
| Description |
Gets the hierarchy | ||
| Return | osid.id.Id | the hierarchy Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFrontOfficeHierarchy | ||
| 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 | canModifyFrontOfficeHierarchy | ||
| 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 | addRootFrontOffice | ||
| Description |
Adds a root front office. | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of a front office |
| Errors | ALREADY_EXISTS | frontOfficeId is already in hierarchy | |
| NOT_FOUND | frontOfficeId not found | ||
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeRootFrontOffice | ||
| Description |
Removes a root front office. | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of a front office |
| Errors | NOT_FOUND | frontOfficeId is not a root | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | addChildFrontOffice | ||
| Description |
Adds a child to a front office. | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of a front office |
osid.id.Id | childId | the Id of the new child | |
| Errors | ALREADY_EXISTS | frontOfficeId is already a parent of childId | |
| NOT_FOUND | frontOfficeId or childId not found | ||
| NULL_ARGUMENT | frontOfficeId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildFrontOffice | ||
| Description |
Removes a child from a front office. | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of a front office |
osid.id.Id | childId | the Id of the new child | |
| Errors | NOT_FOUND | frontOfficeId is not parent of childId | |
| NULL_ARGUMENT | frontOfficeId or childId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | removeChildFrontOffices | ||
| Description |
Removes all children from a front office. | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of a front office |
| Errors | NOT_FOUND | frontOfficeId is not found | |
| NULL_ARGUMENT | frontOfficeId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |