Interface FrontOfficeHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface FrontOfficeHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildFrontOffice(Id frontOfficeId, Id childId)	Adds a child to a front office.
void	addRootFrontOffice(Id frontOfficeId)	Adds a root front office.
boolean	canModifyFrontOfficeHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getFrontOfficeHierarchy()	Gets the hierarchy associated with this session.
Id	getFrontOfficeHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildFrontOffice(Id frontOfficeId, Id childId)	Removes a child from a front office.
void	removeChildFrontOffices(Id frontOfficeId)	Removes all children from a front office.
void	removeRootFrontOffice(Id frontOfficeId)	Removes a root front 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

getFrontOfficeHierarchyId

Id getFrontOfficeHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getFrontOfficeHierarchy

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

canModifyFrontOfficeHierarchy

boolean canModifyFrontOfficeHierarchy()

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.

addRootFrontOffice

void addRootFrontOffice(Id frontOfficeId)
                 throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root front office.

Parameters:

frontOfficeId - the Id of a front office

Throws:

AlreadyExistsException - frontOfficeId is already in hierarchy

NotFoundException - frontOfficeId not found

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootFrontOffice

void removeRootFrontOffice(Id frontOfficeId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root front office.

Parameters:

frontOfficeId - the Id of a front office

Throws:

NotFoundException - frontOfficeId is not a root

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildFrontOffice

void addChildFrontOffice(Id frontOfficeId,
 Id childId)
                  throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a front office.

Parameters:

frontOfficeId - the Id of a front office

childId - the Id of the new child

Throws:

AlreadyExistsException - frontOfficeId is already a parent of childId

NotFoundException - frontOfficeId or childId not found

NullArgumentException - frontOfficeId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildFrontOffice

void removeChildFrontOffice(Id frontOfficeId,
 Id childId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a front office.

Parameters:

frontOfficeId - the Id of a front office

childId - the Id of the new child

Throws:

NotFoundException - frontOfficeId is not parent of childId

NullArgumentException - frontOfficeId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildFrontOffices

void removeChildFrontOffices(Id frontOfficeId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a front office.

Parameters:

frontOfficeId - the Id of a front office

Throws:

NotFoundException - frontOfficeId is not found

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.