Interface ProcessHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ProcessHierarchyDesignSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	addChildProcess(Id processId, Id childId)	Adds a child to a process.
void	addRootProcess(Id processId)	Adds a root process.
boolean	canModifyProcessHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getProcessHierarchy()	Gets the hierarchy associated with this session.
Id	getProcessHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildProcess(Id processId, Id childId)	Removes a child from a process.
void	removeChildProcesses(Id processId)	Removes all children from a process.
void	removeRootProcess(Id processId)	Removes a root process.

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

getProcessHierarchyId

Id getProcessHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getProcessHierarchy

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

canModifyProcessHierarchy

boolean canModifyProcessHierarchy()

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.

addRootProcess

void addRootProcess(Id processId)
             throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root process.

Parameters:

processId - the Id of a process

Throws:

AlreadyExistsException - processId is already in hierarchy

NotFoundException - processId not found

NullArgumentException - processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootProcess

void removeRootProcess(Id processId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root process.

Parameters:

processId - the Id of a process

Throws:

NotFoundException - processId is not a root

NullArgumentException - processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildProcess

void addChildProcess(Id processId,
 Id childId)
              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a process.

Parameters:

processId - the Id of a process

childId - the Id of the new child

Throws:

AlreadyExistsException - processId is already a parent of childId

NotFoundException - processId or childId not found

NullArgumentException - processId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildProcess

void removeChildProcess(Id processId,
 Id childId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a process.

Parameters:

processId - the Id of a process

childId - the Id of the new child

Throws:

NotFoundException - processId not a parent of childId

NullArgumentException - processId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildProcesses

void removeChildProcesses(Id processId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a process.

Parameters:

processId - the Id of a process

Throws:

NotFoundException - processId not in hierarchy

NullArgumentException - processId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.