OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.CampusHierarchySession
Implementsosid.OsidSession
Description

This session defines methods for traversing a hierarchy of Campus objects. Each node in the hierarchy is a unique Campus. The hierarchy may be traversed recursively to establish the tree structure through getParentCampuses() and getChildCampuses(). To relate these Ids to another OSID, getCampusNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Campus available in the Room OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root node or a child of another node.

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 getParentCampuses() or getChildCampuses() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized pathways.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: campus elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
MethodgetCampusHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCampusHierarchy
Description

Gets the hierarchy associated with this session.

Returnosid.hierarchy.Hierarchythe hierarchy associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAccessCampusHierarchy
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations.

Returnboolean false if hierarchy traversal methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeCampusView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryCampusView
Description

A complete view of the Campus returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetRootCampusIds
Description

Gets the root campus Ids in this hierarchy.

Returnosid.id.IdListthe root campus Ids
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRootCampuses
Description

Gets the root campuses in the campus hierarchy. A node with no parents is an orphan. While all campus Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.

Returnosid.room.CampusListthe root campuses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodhasParentCampuses
Description

Tests if the Campus has any parents.

Parametersosid.id.IdcampusIda campus Id
Returnboolean true if the campus has parents, f alse otherwise
ErrorsNOT_FOUND campusId is not found
NULL_ARGUMENT campusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisParentOfCampus
Description

Tests if an Id is a direct parent of campus.

Parametersosid.id.Ididan Id
osid.id.IdcampusIdthe Id of a campus
Returnboolean true if this id is a parent of campusId, f alse otherwise
ErrorsNOT_FOUND campusId is not found
NULL_ARGUMENT id or campusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetParentCampusIds
Description

Gets the parent Ids of the given campus.

Parametersosid.id.IdcampusIda campus Id
Returnosid.id.IdListthe parent Ids of the campus
ErrorsNOT_FOUND campusId is not found
NULL_ARGUMENT campusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParentCampuses
Description

Gets the parent campuses of the given id.

Parametersosid.id.IdcampusIdthe Id of the Campus to query
Returnosid.room.CampusListthe parent campuses of the id
ErrorsNOT_FOUNDa Campus identified by Id is not found
NULL_ARGUMENT campusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisAncestorOfCampus
Description

Tests if an Id is an ancestor of a campus.

Parametersosid.id.Ididan Id
osid.id.IdcampusIdthe Id of a campus
Returnboolean tru e if this id is an ancestor of campusId, false otherwise
ErrorsNOT_FOUND campusId is not found
NULL_ARGUMENT id or campusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodhasChildCampuses
Description

Tests if a campus has any children.

Parametersosid.id.IdcampusIda campus Id
Returnboolean true if the campusId has children, false otherwise
ErrorsNOT_FOUND campusId is not found
NULL_ARGUMENT campusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisChildOfCampus
Description

Tests if a campus is a direct child of another.

Parametersosid.id.Ididan Id
osid.id.IdcampusIdthe Id of a campus
Returnboolean true if the id is a child of campusId, false otherwise
ErrorsNOT_FOUND campusId is not found
NULL_ARGUMENT id or campusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetChildCampusIds
Description

Gets the child Ids of the given campus.

Parametersosid.id.IdcampusIdthe Id to query
Returnosid.id.IdListthe children of the campus
ErrorsNOT_FOUND campusId is not found
NULL_ARGUMENT campusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChildCampuses
Description

Gets the child campuses of the given id.

Parametersosid.id.IdcampusIdthe Id of the Campus to query
Returnosid.room.CampusListthe child campuses of the id
ErrorsNOT_FOUNDa Campus identified by Id is not found
NULL_ARGUMENT campusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisDescendantOfCampus
Description

Tests if an Id is a descendant of a campus.

Parametersosid.id.Ididan Id
osid.id.IdcampusIdthe Id of a campus
Returnboolean true if the id is a descendant of the campusId, false otherwise
ErrorsNOT_FOUND campusId is not found
NULL_ARGUMENT id or campusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id is not found return false.

MethodgetCampusNodeIds
Description

Gets a portion of the hierarchy for the given campus.

Parametersosid.id.IdcampusIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.hierarchy.Nodea campus node
ErrorsNOT_FOUND campusId is not found
NULL_ARGUMENT campusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCampusNodes
Description

Gets a portion of the hierarchy for the given campus.

Parametersosid.id.IdcampusIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.room.CampusNodea campus node
ErrorsNOT_FOUND campusId is not found
NULL_ARGUMENT campusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.