Interface CampusHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CampusHierarchyDesignSession
extends OsidSession

This session manages a hierarchy of campuses. Campuses may be organized into a hierarchy for organizing or federating. A parent Campus includes all of the rooms of its children such that a single root node contains all of the rooms of the federation.

Method Summary

Modifier and Type	Method	Description
void	addChildCampus(Id campusId, Id childId)	Adds a child to a campus.
void	addRootCampus(Id campusId)	Adds a root campus.
boolean	canModifyCampusHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getCampusHierarchy()	Gets the hierarchy associated with this session.
Id	getCampusHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildCampus(Id campusId, Id childId)	Removes a child from a campus.
void	removeChildCampuses(Id campusId)	Removes all children from a campus.
void	removeRootCampus(Id campusId)	Removes a root campus.

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.

canModifyCampusHierarchy

boolean canModifyCampusHierarchy()

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returns:

false if changing this hierarchy is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addRootCampus

void addRootCampus(Id campusId)
            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root campus.

Parameters:

campusId - the Id of a campus

Throws:

AlreadyExistsException - campusId is already in hierarchy

NotFoundException - campusId is not found

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootCampus

void removeRootCampus(Id campusId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root campus.

Parameters:

campusId - the Id of a campus

Throws:

NotFoundException - campusId is not a root

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildCampus

void addChildCampus(Id campusId,
 Id childId)
             throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a campus.

Parameters:

campusId - the Id of a campus

childId - the Id of the new child

Throws:

AlreadyExistsException - campusId is already a parent of childId

NotFoundException - campusId or childId not found

NullArgumentException - campusId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildCampus

void removeChildCampus(Id campusId,
 Id childId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a campus.

Parameters:

campusId - the Id of a campus

childId - the Id of the new child

Throws:

NotFoundException - campusId not a parent of childId

NullArgumentException - campusId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildCampuses

void removeChildCampuses(Id campusId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a campus.

Parameters:

campusId - the Id of a campus

Throws:

NotFoundException - campusId not found

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.