Interface | osid.room.CampusHierarchySession | ||
---|---|---|---|
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 | getCampusHierarchyId | ||
Description |
Gets the hierarchy | ||
Return | osid.id.Id | the hierarchy Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCampusHierarchy | ||
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 | canAccessCampusHierarchy | ||
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 | useComparativeCampusView | ||
Description |
The returns from the campus 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 | usePlenaryCampusView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRootCampusIds | ||
Description |
Gets the root campus | ||
Return | osid.id.IdList | the root campus Ids | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRootCampuses | ||
Description |
Gets the root campuses in the campus hierarchy. A node
with no parents is an orphan. While all campus | ||
Return | osid.room.CampusList | the root campuses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | hasParentCampuses | ||
Description |
Tests if the | ||
Parameters | osid.id.Id | campusId | a campus Id |
Return | boolean | true if the campus has parents, f alse
otherwise | |
Errors | NOT_FOUND | campusId is not found | |
NULL_ARGUMENT | campusId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isParentOfCampus | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | campusId | the Id of a campus | |
Return | boolean | true if this id is a parent of
campusId, f alse otherwise | |
Errors | NOT_FOUND | campusId is not found | |
NULL_ARGUMENT | id or campusId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getParentCampusIds | ||
Description |
Gets the parent | ||
Parameters | osid.id.Id | campusId | a campus Id |
Return | osid.id.IdList | the parent Ids of the campus | |
Errors | NOT_FOUND | campusId is not found | |
NULL_ARGUMENT | campusId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getParentCampuses | ||
Description |
Gets the parent campuses of the given | ||
Parameters | osid.id.Id | campusId | the Id of the Campus to query |
Return | osid.room.CampusList | the parent campuses of the id | |
Errors | NOT_FOUND | a Campus identified by Id is not found | |
NULL_ARGUMENT | campusId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isAncestorOfCampus | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | campusId | the Id of a campus | |
Return | boolean | tru e if this id is an ancestor of
campusId, false otherwise | |
Errors | NOT_FOUND | campusId is not found | |
NULL_ARGUMENT | id or campusId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | hasChildCampuses | ||
Description |
Tests if a campus has any children. | ||
Parameters | osid.id.Id | campusId | a campus Id |
Return | boolean | true if the campusId has children,
false otherwise | |
Errors | NOT_FOUND | campusId is not found | |
NULL_ARGUMENT | campusId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isChildOfCampus | ||
Description |
Tests if a campus is a direct child of another. | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | campusId | the Id of a campus | |
Return | boolean | true if the id is a child of campusId,
false otherwise | |
Errors | NOT_FOUND | campusId is not found | |
NULL_ARGUMENT | id or campusId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getChildCampusIds | ||
Description |
Gets the child | ||
Parameters | osid.id.Id | campusId | the Id to query |
Return | osid.id.IdList | the children of the campus | |
Errors | NOT_FOUND | campusId is not found | |
NULL_ARGUMENT | campusId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getChildCampuses | ||
Description |
Gets the child campuses of the given | ||
Parameters | osid.id.Id | campusId | the Id of the Campus to query |
Return | osid.room.CampusList | the child campuses of the id | |
Errors | NOT_FOUND | a Campus identified by Id is not found | |
NULL_ARGUMENT | campusId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | isDescendantOfCampus | ||
Description |
Tests if an | ||
Parameters | osid.id.Id | id | an Id |
osid.id.Id | campusId | the Id of a campus | |
Return | boolean | true if the id is a descendant of the
campusId, false otherwise | |
Errors | NOT_FOUND | campusId is not found | |
NULL_ARGUMENT | id or campusId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If | ||
Method | getCampusNodeIds | ||
Description |
Gets a portion of the hierarchy for the given campus. | ||
Parameters | osid.id.Id | campusId | the Id to query |
cardinal | ancestorLevels | the maximum number of ancestor levels to include. A value of 0 returns no parents in the node. | |
cardinal | descendantLevels | the maximum number of descendant levels to include. A value of 0 returns no children in the node. | |
boolean | includeSiblings | true to include the siblings of the given node, false
to omit the siblings | |
Return | osid.hierarchy.Node | a campus node | |
Errors | NOT_FOUND | campusId is not found | |
NULL_ARGUMENT | campusId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCampusNodes | ||
Description |
Gets a portion of the hierarchy for the given campus. | ||
Parameters | osid.id.Id | campusId | the Id to query |
cardinal | ancestorLevels | the maximum number of ancestor levels to include. A value of 0 returns no parents in the node. | |
cardinal | descendantLevels | the maximum number of descendant levels to include. A value of 0 returns no children in the node. | |
boolean | includeSiblings | true to include the siblings of the given node, false
to omit the siblings | |
Return | osid.room.CampusNode | a campus node | |
Errors | NOT_FOUND | campusId is not found | |
NULL_ARGUMENT | campusId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |