Interface | osid.workflow.OfficeHierarchySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for traversing a hierarchy of
A user may not be authorized to traverse the entire
hierarchy. Parts of the hierarchy may be made invisible
through omission from the returns of This session defines views that offer differing behaviors when retrieving multiple objects.
| ||
Method | getOfficeHierarchyId | ||
Description |
Gets the hierarchy | ||
Return | osid.id.Id | the hierarchy Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getOfficeHierarchy | ||
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 | canAccessOfficeHierarchy | ||
Description |
Tests if this user can perform hierarchy queries. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known all methods in this session will result in a | ||
Return | boolean | false if hierarchy traversal methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeOfficeView | ||
Description |
The returns from the office methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryOfficeView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRootOfficeIds | ||
Description |
Gets the root office | ||
Return | osid.id.IdList | the root office Ids | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRootOffices | ||
Description |
Gets the root office in the office hierarchy. A
availability with no parents is an orphan. While all
office | ||
Return | osid.workflow.OfficeList | the root offices | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | hasParentOffices | ||
Description |
Tests if the | ||
Parameters | osid.id.Id | officeId | an office Id |
Return | boolean | true if the office has parents, f alse
otherwise | |
Errors | NOT_FOUND | officeId is not found | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isParentOfOffice | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | officeId | the Id of an office | |
Return | boolean | true if this id is a parent of
officeId, f alse otherwise | |
Errors | NOT_FOUND | officeId is not found | |
NULL_ARGUMENT | id or officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getParentOfficeIds | ||
Description |
Gets the parent | ||
Parameters | osid.id.Id | officeId | an office Id |
Return | osid.id.IdList | the parent Ids of the office | |
Errors | NOT_FOUND | officeId is not found | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getParentOffices | ||
Description |
Gets the parents of the given office. | ||
Parameters | osid.id.Id | officeId | the Id to query |
Return | osid.workflow.OfficeList | the parents of the office | |
Errors | NOT_FOUND | officeId not found | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isAncestorOfOffice | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | officeId | the Id of an office | |
Return | boolean | tru e if this id is an ancestor of
officeId, false otherwise | |
Errors | NOT_FOUND | officeId not found | |
NULL_ARGUMENT | officeId or id is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | hasChildOffices | ||
Description |
Tests if an office has any children. | ||
Parameters | osid.id.Id | officeId | an office Id |
Return | boolean | true if the officeId has children,
false otherwise | |
Errors | NOT_FOUND | officeId not found | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isChildOfOffice | ||
Description |
Tests if an office is a direct child of another. | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | officeId | the Id of an office | |
Return | boolean | true if the Id is a child of officeId,
false otherwise | |
Errors | NOT_FOUND | officeId not found | |
NULL_ARGUMENT | id or officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getChildOfficeIds | ||
Description |
Gets the child | ||
Parameters | osid.id.Id | officeId | the Id to query |
Return | osid.id.IdList | the children of the office | |
Errors | NOT_FOUND | officeId not found | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getChildOffices | ||
Description |
Gets the children of the given office. | ||
Parameters | osid.id.Id | officeId | the Id to query |
Return | osid.workflow.OfficeList | the children of the office | |
Errors | NOT_FOUND | officeId not found | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isDescendantOfOffice | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | officeId | the Id of an office | |
Return | boolean | true if the id is a descendant of the
officeId, false otherwise | |
Errors | NOT_FOUND | officeId not found | |
NULL_ARGUMENT | id or officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getOfficeNodeIds | ||
Description |
Gets a portion of the hierarchy for the given office. | ||
Parameters | osid.id.Id | officeId | the Id to query |
cardinal | ancestorLevels | the maximum number of ancestor levels to include. A value of 0 returns no parents in the availability. | |
cardinal | descendantLevels | the maximum number of descendant levels to include. A value of 0 returns no children in the availability. | |
boolean | includeSiblings | true to include the siblings of the given availability,
false to omit the siblings | |
Return | osid.hierarchy.Node | an office node | |
Errors | NOT_FOUND | officeId not found | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOfficeNodes | ||
Description |
Gets a portion of the hierarchy for the given office. | ||
Parameters | osid.id.Id | officeId | the Id to query |
cardinal | ancestorLevels | the maximum number of ancestor levels to include. A value of 0 returns no parents in the availability. | |
cardinal | descendantLevels | the maximum number of descendant levels to include. A value of 0 returns no children in the availability. | |
boolean | includeSiblings | true to include the siblings of the given availability,
false to omit the siblings | |
Return | osid.workflow.OfficeNode | an office node | |
Errors | NOT_FOUND | officeId not found | |
NULL_ARGUMENT | officeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |