Interface OfficeHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface OfficeHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildOffice(Id officeId, Id childId)	Adds a child to an office.
void	addRootOffice(Id officeId)	Adds a root office.
boolean	canModifyOfficeHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getOfficeHierarchy()	Gets the hierarchy associated with this session.
Id	getOfficeHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildOffice(Id officeId, Id childId)	Removes a child from an office.
void	removeChildOffices(Id officeId)	Removes all children from an office.
void	removeRootOffice(Id officeId)	Removes a root office.

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

getOfficeHierarchyId

Id getOfficeHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getOfficeHierarchy

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

canModifyOfficeHierarchy

boolean canModifyOfficeHierarchy()

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.

addRootOffice

void addRootOffice(Id officeId)
            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root office.

Parameters:

officeId - the Id of an office

Throws:

AlreadyExistsException - officeId is already in hierarchy

NotFoundException - officeId not found

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootOffice

void removeRootOffice(Id officeId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root office.

Parameters:

officeId - the Id of an office

Throws:

NotFoundException - officeId is not a root

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildOffice

void addChildOffice(Id officeId,
 Id childId)
             throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to an office.

Parameters:

officeId - the Id of an office

childId - the Id of the new child

Throws:

AlreadyExistsException - officeId is already a parent of childId

NotFoundException - officeId or childId not found

NullArgumentException - officeId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildOffice

void removeChildOffice(Id officeId,
 Id childId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from an office.

Parameters:

officeId - the Id of an office

childId - the Id of the new child

Throws:

NotFoundException - officeId is not parent of childId

NullArgumentException - officeId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildOffices

void removeChildOffices(Id officeId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from an office.

Parameters:

officeId - the Id of an office

Throws:

NotFoundException - officeId is not found

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.