Interface ProcessHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ProcessHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Process objects. Each node in the hierarchy is a unique Process . The hierarchy may be traversed recursively to establish the tree structure through getParentProcesses() and getChildProcesses() . To relate these Ids to another OSID, getProcessNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Process available in the Process OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root node or a child of another node.

A user may not be authorized to traverse the entire hierarchy. Parts of the hierarchy may be made invisible through omission from the returns of getParentProcesses() or getChildProcesses() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized pathways.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: process elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canAccessProcessHierarchy()	Tests if this user can perform hierarchy queries.
ProcessList	getChildProcesses(Id processId)	Gets the children of the given process.
IdList	getChildProcessIds(Id processId)	Gets the child Ids of the given process.
ProcessList	getParentProcesses(Id processId)	Gets the parents of the given process.
IdList	getParentProcessIds(Id processId)	Gets the parent Ids of the given process.
Hierarchy	getProcessHierarchy()	Gets the hierarchy associated with this session.
Id	getProcessHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getProcessNodeIds(Id processId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given process.
ProcessNode	getProcessNodes(Id processId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given process.
ProcessList	getRootProcesses()	Gets the root processes in the process hierarchy.
IdList	getRootProcessIds()	Gets the root process Ids in this hierarchy.
boolean	hasChildProcesses(Id processId)	Tests if a process has any children.
boolean	hasParentProcesses(Id processId)	Tests if the Process has any parents.
boolean	isAncestorOfProcess(Id id, Id processId)	Tests if an Id is an ancestor of a process.
boolean	isChildOfProcess(Id id, Id processId)	Tests if a process is a direct child of another.
boolean	isDescendantOfProcess(Id id, Id processId)	Tests if an Id is a descendant of a process.
boolean	isParentOfProcess(Id id, Id processId)	Tests if an Id is a direct parent of a process.
void	useComparativeProcessView()	The returns from the process methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryProcessView()	A complete view of the Process returns is desired.

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.

canAccessProcessHierarchy

boolean canAccessProcessHierarchy()

Tests if this user can perform hierarchy queries. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeProcessView

void useComparativeProcessView()

The returns from the process methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryProcessView

void usePlenaryProcessView()

A complete view of the Process returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getRootProcessIds

IdList getRootProcessIds()
                  throws OperationFailedException,
PermissionDeniedException

Gets the root process Ids in this hierarchy.

Returns:

the root process Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootProcesses

ProcessList getRootProcesses()
                      throws OperationFailedException,
PermissionDeniedException

Gets the root processes in the process hierarchy. A node with no parents is an orphan. While all process Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.

Returns:

the root processes

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentProcesses

boolean hasParentProcesses(Id processId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Process has any parents.

Parameters:

processId - a process Id

Returns:

true if the process has parents, false otherwise

Throws:

NotFoundException - processId is not found

NullArgumentException - processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfProcess

boolean isParentOfProcess(Id id,
 Id processId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of a process.

Parameters:

id - an Id

processId - a process Id

Returns:

true if this id is a parent of processId , false otherwise

Throws:

NotFoundException - processId is not found

NullArgumentException - id or processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getParentProcessIds

IdList getParentProcessIds(Id processId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given process.

Parameters:

processId - a process Id

Returns:

the parent Ids of the process

Throws:

NotFoundException - processId is not found

NullArgumentException - processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentProcesses

ProcessList getParentProcesses(Id processId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parents of the given process.

Parameters:

processId - the Id to query

Returns:

the parents of the process

Throws:

NotFoundException - processId not found

NullArgumentException - processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfProcess

boolean isAncestorOfProcess(Id id,
 Id processId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a process.

Parameters:

id - an Id

processId - the Id of a process

Returns:

true if this id is an ancestor of processId , false otherwise

Throws:

NotFoundException - processId not found

NullArgumentException - processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

hasChildProcesses

boolean hasChildProcesses(Id processId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a process has any children.

Parameters:

processId - a processId

Returns:

true if the processId has children, false otherwise

Throws:

NotFoundException - processId not found

NullArgumentException - processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfProcess

boolean isChildOfProcess(Id id,
 Id processId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a process is a direct child of another.

Parameters:

id - an Id

processId - the Id of a process

Returns:

true if the id is a child of processId , false otherwise

Throws:

NotFoundException - processId not found

NullArgumentException - processId or id is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getChildProcessIds

IdList getChildProcessIds(Id processId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given process.

Parameters:

processId - the Id to query

Returns:

the children of the process

Throws:

NotFoundException - processId not found

NullArgumentException - processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildProcesses

ProcessList getChildProcesses(Id processId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the children of the given process.

Parameters:

processId - the Id to query

Returns:

the children of the process

Throws:

NotFoundException - processId not found

NullArgumentException - processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfProcess

boolean isDescendantOfProcess(Id id,
 Id processId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a process.

Parameters:

id - an Id

processId - the Id of a process

Returns:

true if the id is a descendant of the processId , false otherwise

Throws:

NotFoundException - processId not found

NullArgumentException - processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} is not found return {@code false} .

getProcessNodeIds

Node getProcessNodeIds(Id processId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given process.

Parameters:

processId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a process node

Throws:

NotFoundException - processId not found

NullArgumentException - processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProcessNodes

ProcessNode getProcessNodes(Id processId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given process.

Parameters:

processId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a process node

Throws:

NotFoundException - processId not found

NullArgumentException - processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.