Interface OrganizationHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface OrganizationHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildOrganization(Id organizationId, Id childId)	Adds a child to an organization.
void	addRootOrganization(Id organizationId)	Adds a root organization.
boolean	canModifyOrganizationHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getOrganizationHierarchy()	Gets the hierarchy associated with this session.
Id	getOrganizationHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildOrganization(Id organizationId, Id childId)	Removes a child from an organization.
void	removeChildOrganizations(Id organizationId)	Removes all children from an organization.
void	removeRootOrganization(Id organizationId)	Removes a root organization.

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

getOrganizationHierarchyId

Id getOrganizationHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getOrganizationHierarchy

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

canModifyOrganizationHierarchy

boolean canModifyOrganizationHierarchy()

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.

addRootOrganization

void addRootOrganization(Id organizationId)
                  throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root organization.

Parameters:

organizationId - the Id of an organization

Throws:

AlreadyExistsException - organizationId is already in hierarchy

NotFoundException - organizationId not found

NullArgumentException - organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootOrganization

void removeRootOrganization(Id organizationId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root organization.

Parameters:

organizationId - the Id of an organization

Throws:

NotFoundException - organizationId not found

NullArgumentException - organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildOrganization

void addChildOrganization(Id organizationId,
 Id childId)
                   throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to an organization.

Parameters:

organizationId - the Id of an organization

childId - the Id of the new child

Throws:

AlreadyExistsException - organizationId is already a parent of childId

NotFoundException - organizationId or childId not found

NullArgumentException - organizationId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildOrganization

void removeChildOrganization(Id organizationId,
 Id childId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from an organization.

Parameters:

organizationId - the Id of a n organization

childId - the Id of the new child

Throws:

NotFoundException - organizationId not a parent of childId

NullArgumentException - organizationId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildOrganizations

void removeChildOrganizations(Id organizationId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from an organization.

Parameters:

organizationId - the Id of an organization

Throws:

NotFoundException - organizationId not found

NullArgumentException - organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.