Interface AgencyHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AgencyHierarchyDesignSession
extends OsidSession

This session defines methods for managing a hierarchy of Agency objects. Each node in the hierarchy is a unique Agency .

Method Summary

Modifier and Type	Method	Description
void	addChildAgency(Id agencyId, Id childId)	Adds a child to an agency.
void	addRootAgency(Id agencyId)	Adds a root agency.
boolean	canModifyAgencyHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getAgencyHierarchy()	Gets the hierarchy associated with this session.
Id	getAgencyHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildAgencies(Id agencyId)	Removes all children from an agency.
void	removeChildAgency(Id agencyId, Id childId)	Removes a child from an agency.
void	removeRootAgency(Id agencyId)	Removes a root agency from this hierarchy.

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

getAgencyHierarchyId

Id getAgencyHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getAgencyHierarchy

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

canModifyAgencyHierarchy

boolean canModifyAgencyHierarchy()

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.

addRootAgency

void addRootAgency(Id agencyId)
            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root agency.

Parameters:

agencyId - the Id of an agency

Throws:

AlreadyExistsException - agencyId is already in hierarchy

NotFoundException - agency not found

NullArgumentException - agencyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootAgency

void removeRootAgency(Id agencyId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root agency from this hierarchy.

Parameters:

agencyId - the Id of an agency

Throws:

NotFoundException - agencyId not a parent of childId

NullArgumentException - agencyId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildAgency

void addChildAgency(Id agencyId,
 Id childId)
             throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to an agency.

Parameters:

agencyId - the Id of an agency

childId - the Id of the new child

Throws:

AlreadyExistsException - agencyId already a parent of childId

NotFoundException - agencyId or childId not found

NullArgumentException - agencyId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildAgency

void removeChildAgency(Id agencyId,
 Id childId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from an agency.

Parameters:

agencyId - the Id of an agency

childId - the Id of the new child

Throws:

NotFoundException - agencyId is not a parent of childId

NullArgumentException - agencyId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildAgencies

void removeChildAgencies(Id agencyId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from an agency.

Parameters:

agencyId - the Id of an agency

Throws:

NotFoundException - agencyId is not in hierarchy

NullArgumentException - agencyId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.