Interface CampusHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CampusHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Campuses . 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

Method Summary

Modifier and Type	Method	Description
boolean	canAccessCampusHierarchy()	Tests if this user can perform hierarchy queries.
Hierarchy	getCampusHierarchy()	Gets the hierarchy associated with this session.
Id	getCampusHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getCampusNodeIds(Id campusId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given campus.
CampusNode	getCampusNodes(Id campusId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given campus.
CampusList	getChildCampuses(Id campusId)	Gets the child campuses of the given id .
IdList	getChildCampusIds(Id campusId)	Gets the child Ids of the given campus.
CampusList	getParentCampuses(Id campusId)	Gets the parent campuses of the given id .
IdList	getParentCampusIds(Id campusId)	Gets the parent Ids of the given campus.
CampusList	getRootCampuses()	Gets the root campuses in the campus hierarchy.
IdList	getRootCampusIds()	Gets the root campus Ids in this hierarchy.
boolean	hasChildCampuses(Id campusId)	Tests if a campus has any children.
boolean	hasParentCampuses(Id campusId)	Tests if the Campus has any parents.
boolean	isAncestorOfCampus(Id id, Id campusId)	Tests if an Id is an ancestor of a campus.
boolean	isChildOfCampus(Id id, Id campusId)	Tests if a campus is a direct child of another.
boolean	isDescendantOfCampus(Id id, Id campusId)	Tests if an Id is a descendant of a campus.
boolean	isParentOfCampus(Id id, Id campusId)	Tests if an Id is a direct parent of campus.
void	useComparativeCampusView()	The returns from the campus methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryCampusView()	A complete view of the Campus returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getCampusHierarchyId

Id getCampusHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCampusHierarchy

Hierarchy getCampusHierarchy()
                      throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAccessCampusHierarchy

boolean canAccessCampusHierarchy()

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.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeCampusView

void useComparativeCampusView()

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.

usePlenaryCampusView

void usePlenaryCampusView()

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.

Compliance:

mandatory - This method is must be implemented.

getRootCampusIds

IdList getRootCampusIds()
                 throws OperationFailedException,
PermissionDeniedException

Gets the root campus Ids in this hierarchy.

Returns:

the root campus Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootCampuses

CampusList getRootCampuses()
                    throws OperationFailedException,
PermissionDeniedException

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.

Returns:

the root campuses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentCampuses

boolean hasParentCampuses(Id campusId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Campus has any parents.

Parameters:

campusId - a campus Id

Returns:

true if the campus has parents, f alse otherwise

Throws:

NotFoundException - campusId is not found

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfCampus

boolean isParentOfCampus(Id id,
 Id campusId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of campus.

Parameters:

id - an Id

campusId - the Id of a campus

Returns:

true if this id is a parent of campusId , f alse otherwise

Throws:

NotFoundException - campusId is not found

NullArgumentException - id or campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getParentCampusIds

IdList getParentCampusIds(Id campusId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given campus.

Parameters:

campusId - a campus Id

Returns:

the parent Ids of the campus

Throws:

NotFoundException - campusId is not found

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentCampuses

CampusList getParentCampuses(Id campusId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent campuses of the given id .

Parameters:

campusId - the Id of the Campus to query

Returns:

the parent campuses of the id

Throws:

NotFoundException - a Campus identified by Id is not found

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfCampus

boolean isAncestorOfCampus(Id id,
 Id campusId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a campus.

Parameters:

id - an Id

campusId - the Id of a campus

Returns:

true if this id is an ancestor of campusId , false otherwise

Throws:

NotFoundException - campusId is not found

NullArgumentException - id or campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

hasChildCampuses

boolean hasChildCampuses(Id campusId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a campus has any children.

Parameters:

campusId - a campus Id

Returns:

true if the campusId has children, false otherwise

Throws:

NotFoundException - campusId is not found

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfCampus

boolean isChildOfCampus(Id id,
 Id campusId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a campus is a direct child of another.

Parameters:

id - an Id

campusId - the Id of a campus

Returns:

true if the id is a child of campusId , false otherwise

Throws:

NotFoundException - campusId is not found

NullArgumentException - id or campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getChildCampusIds

IdList getChildCampusIds(Id campusId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given campus.

Parameters:

campusId - the Id to query

Returns:

the children of the campus

Throws:

NotFoundException - campusId is not found

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildCampuses

CampusList getChildCampuses(Id campusId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child campuses of the given id .

Parameters:

campusId - the Id of the Campus to query

Returns:

the child campuses of the id

Throws:

NotFoundException - a Campus identified by Id is not found

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfCampus

boolean isDescendantOfCampus(Id id,
 Id campusId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a campus.

Parameters:

id - an Id

campusId - the Id of a campus

Returns:

true if the id is a descendant of the campusId , false otherwise

Throws:

NotFoundException - campusId is not found

NullArgumentException - id or campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} is not found return {@code false} .

getCampusNodeIds

Node getCampusNodeIds(Id campusId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given campus.

Parameters:

campusId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a campus node

Throws:

NotFoundException - campusId is not found

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCampusNodes

CampusNode getCampusNodes(Id campusId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given campus.

Parameters:

campusId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a campus node

Throws:

NotFoundException - campusId is not found

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.