Interface UtilityHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface UtilityHierarchyDesignSession
extends OsidSession

This session manages a hierarchy of utilities. Utilities may be organized into a hierarchy for organizing or federating. A parent Utility includes all of the Ids of its children such that a single root node contains all of the Ids of the federation.

Method Summary

Modifier and Type	Method	Description
void	addChildUtility(Id utilityId, Id childId)	Adds a child to a utility.
void	addRootUtility(Id utilityId)	Adds a root utility.
boolean	canModifyUtilityHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getUtilityHierarchy()	Gets the hierarchy associated with this session.
Id	getUtilityHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildUtilities(Id utilityId)	Removes all children from a utility.
void	removeChildUtility(Id utilityId, Id childId)	Removes a child from a utility.
void	removeRootUtility(Id utilityId)	Removes a root utility.

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

getUtilityHierarchyId

Id getUtilityHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getUtilityHierarchy

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

canModifyUtilityHierarchy

boolean canModifyUtilityHierarchy()

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.

addRootUtility

void addRootUtility(Id utilityId)
             throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root utility.

Parameters:

utilityId - the Id of a utility

Throws:

AlreadyExistsException - utilityId is already in hierarchy

NotFoundException - utilityId not found

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootUtility

void removeRootUtility(Id utilityId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root utility.

Parameters:

utilityId - the Id of a utility

Throws:

NotFoundException - utilityId is not a root

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildUtility

void addChildUtility(Id utilityId,
 Id childId)
              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a utility.

Parameters:

utilityId - the Id of a utility

childId - the Id of the new child

Throws:

AlreadyExistsException - utilityId is already a parent of childId

NotFoundException - utilityId or childId not found

NullArgumentException - utilityId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildUtility

void removeChildUtility(Id utilityId,
 Id childId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a utility.

Parameters:

utilityId - the Id of a utility

childId - the Id of the new child

Throws:

NotFoundException - utilityId not a parent of childId

NullArgumentException - utilityId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildUtilities

void removeChildUtilities(Id utilityId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a utility.

Parameters:

utilityId - the Id of a utility

Throws:

NotFoundException - utilityId not found

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.