Interface | osid.tracking.FrontOfficeHierarchySession | ||
---|---|---|---|
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 | 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 | canAccessFrontOfficeHierarchy | ||
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 | useComparativeFrontOfficeView | ||
Description |
The returns from the front 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 | usePlenaryFrontOfficeView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRootFrontOfficeIds | ||
Description |
Gets the root front office | ||
Return | osid.id.IdList | the root front office Ids | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRootFrontOffices | ||
Description |
Gets the root front office in the front office
hierarchy. A issue with no parents is an orphan. While all
front office | ||
Return | osid.tracking.FrontOfficeList | the root frontOffices | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | hasParentFrontOffices | ||
Description |
Tests if the | ||
Parameters | osid.id.Id | frontOfficeId | a front office Id |
Return | boolean | true if the front office has parents, f alse
otherwise | |
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. | |
Method | isParentOfFrontOffice | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | frontOfficeId | the Id of a front office | |
Return | boolean | true if this id is a parent of
frontOfficeId, f alse otherwise | |
Errors | NOT_FOUND | frontOfficeId is not found | |
NULL_ARGUMENT | id or frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getParentFrontOfficeIds | ||
Description |
Gets the parent | ||
Parameters | osid.id.Id | frontOfficeId | a front office Id |
Return | osid.id.IdList | the parent Ids of the 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. | |
Method | getParentFrontOffices | ||
Description |
Gets the parents of the given front office. | ||
Parameters | osid.id.Id | frontOfficeId | the Id to query |
Return | osid.tracking.FrontOfficeList | the parents of the front office | |
Errors | 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 | isAncestorOfFrontOffice | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | frontOfficeId | the Id of a front office | |
Return | boolean | tru e if this id is an ancestor of
frontOfficeId, false otherwise | |
Errors | NOT_FOUND | frontOfficeId not found | |
NULL_ARGUMENT | frontOfficeId 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 | hasChildFrontOffices | ||
Description |
Tests if a front office has any children. | ||
Parameters | osid.id.Id | frontOfficeId | a front office Id |
Return | boolean | true if the frontOfficeId has children,
false otherwise | |
Errors | 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 | isChildOfFrontOffice | ||
Description |
Tests if a front office is a direct child of another. | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | frontOfficeId | the Id of a front office | |
Return | boolean | true if the id is a child of
frontOfficeId, false otherwise | |
Errors | NOT_FOUND | frontOfficeId not found | |
NULL_ARGUMENT | id or frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getChildFrontOfficeIds | ||
Description |
Gets the child | ||
Parameters | osid.id.Id | frontOfficeId | the Id to query |
Return | osid.id.IdList | the children of the front office | |
Errors | 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 | getChildFrontOffices | ||
Description |
Gets the children of the given front office. | ||
Parameters | osid.id.Id | frontOfficeId | the Id to query |
Return | osid.tracking.FrontOfficeList | the children of the front office | |
Errors | 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 | isDescendantOfFrontOffice | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | frontOfficeId | the Id of a front office | |
Return | boolean | true if the id is a descendant of the
frontOfficeId, false otherwise | |
Errors | NOT_FOUND | frontOfficeId not found | |
NULL_ARGUMENT | id or frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getFrontOfficeNodeIds | ||
Description |
Gets a portion of the hierarchy for the given front office. | ||
Parameters | osid.id.Id | frontOfficeId | the Id to query |
cardinal | ancestorLevels | the maximum number of ancestor levels to include. A value of 0 returns no parents in the issue. | |
cardinal | descendantLevels | the maximum number of descendant levels to include. A value of 0 returns no children in the issue. | |
boolean | includeSiblings | true to include the siblings of the given issue,
false to omit the siblings | |
Return | osid.hierarchy.Node | a front office node | |
Errors | 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 | getFrontOfficeNodes | ||
Description |
Gets a portion of the hierarchy for the given front office. | ||
Parameters | osid.id.Id | frontOfficeId | the Id to query |
cardinal | ancestorLevels | the maximum number of ancestor levels to include. A value of 0 returns no parents in the issue. | |
cardinal | descendantLevels | the maximum number of descendant levels to include. A value of 0 returns no children in the issue. | |
boolean | includeSiblings | true to include the siblings of the given issue,
false to omit the siblings | |
Return | osid.tracking.FrontOfficeNode | a front office node | |
Errors | 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. |