Interface AcademyHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AcademyHierarchyDesignSession
extends OsidSession

This session manages a hierarchy of academies. Academies may be organized into a hierarchy for organizing or federating. A parent Academy includes all of the conferrals of its children such that a single root node contains all of the conferrals of the federation.

Method Summary

Modifier and Type	Method	Description
void	addChildAcademy(Id academyId, Id childId)	Adds a child to an academy.
void	addRootAcademy(Id academyId)	Adds a root academy.
boolean	canModifyAcademyHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getAcademyHierarchy()	Gets the hierarchy associated with this session.
Id	getAcademyHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildAcademies(Id academyId)	Removes all children from an academy.
void	removeChildAcademy(Id academyId, Id childId)	Removes a child from an academy.
void	removeRootAcademy(Id academyId)	Removes a root academy.

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

getAcademyHierarchyId

Id getAcademyHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getAcademyHierarchy

Hierarchy getAcademyHierarchy()
                       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.

canModifyAcademyHierarchy

boolean canModifyAcademyHierarchy()

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.

addRootAcademy

void addRootAcademy(Id academyId)
             throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root academy.

Parameters:

academyId - the Id of an academy

Throws:

AlreadyExistsException - academyId is already in hierarchy

NotFoundException - academyId is not found

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootAcademy

void removeRootAcademy(Id academyId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root academy.

Parameters:

academyId - the Id of an academy

Throws:

NotFoundException - academyId is not a root

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildAcademy

void addChildAcademy(Id academyId,
 Id childId)
              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to an academy.

Parameters:

academyId - the Id of an academy

childId - the Id of the new child

Throws:

AlreadyExistsException - academyId is already a parent of childId

NotFoundException - academyId or childId not found

NullArgumentException - academyId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildAcademy

void removeChildAcademy(Id academyId,
 Id childId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from an academy.

Parameters:

academyId - the Id of an academy

childId - the Id of the new child

Throws:

NotFoundException - academyId not a parent of childId

NullArgumentException - academyId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildAcademies

void removeChildAcademies(Id academyId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from an academy.

Parameters:

academyId - the Id of an academy

Throws:

NotFoundException - academyId not found

NullArgumentException - academyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.