Interface ProcessProcessorRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ProcessProcessorRuleApplicationSession
extends OsidSession

This session provides methods to apply ProcessProcessors to Processes. Multiple ProcessProcessors applied to an Process may be sequenced such that the first positive evaluation results in the ProcessProcessor used.

Method Summary

Modifier and Type	Method	Description
void	assignProcessProcessorToProcess(Id processProcessorId, Id processId)	Adds an existing ProcessProcessor to a Process.
boolean	canAssignProcessProcessors()	Tests if this user can alter process processor/process mappings.
boolean	canSequenceProcessProcessors()	Tests if this user can order ProcessProcessors.
Office	getOffice()	Gets the Office associated with this session.
Id	getOfficeId()	Gets the Office Id associated with this session.
void	moveProcessProcessorAhead(Id processProcessorId, Id processId, Id referenceId)	Reorders process processors for a process by moving the specified process processor in front of a reference process processor.
void	moveProcessProcessorBehind(Id processProcessorId, Id processId, Id referenceId)	Reorders process processors for a process by moving the specified process processor behind a reference process processor.
void	orderProcessProcessors(Id[] processProcessorIds, Id processId)	Reorders a set of process processors for a process.
void	unassignProcessProcessorFromProcess(Id processProcessorId, Id processId)	Removes an existing ProcessProcessor from a 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

getOfficeId

Id getOfficeId()

Gets the Office Id associated with this session.

Returns:

the Office Id associated with this session

Compliance:

mandatory - This method must be implemented.

getOffice

Office getOffice()
          throws OperationFailedException,
PermissionDeniedException

Gets the Office associated with this session.

Returns:

the office

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignProcessProcessors

boolean canAssignProcessProcessors()

Tests if this user can alter process processor/process mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

assignProcessProcessorToProcess

void assignProcessProcessorToProcess(Id processProcessorId,
 Id processId)
                              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing ProcessProcessor to a Process.

Parameters:

processProcessorId - the Id of the ProcessProcessor

processId - the Id of the Process

Throws:

AlreadyExistsException - processProcessorId already applied to processId

NotFoundException - processProcessorId or processId not found

NullArgumentException - processProcessorId or processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignProcessProcessorFromProcess

void unassignProcessProcessorFromProcess(Id processProcessorId,
 Id processId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing ProcessProcessor from a Process.

Parameters:

processProcessorId - the Id of the ProcessProcessor

processId - the Id of the Process

Throws:

NotFoundException - processProcessorId or processId not found or processProcessorId already applied to processId

NullArgumentException - processProcessorId or processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceProcessProcessors

boolean canSequenceProcessProcessors()

Tests if this user can order ProcessProcessors. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED.This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returns:

false if ProcessProcessor ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveProcessProcessorAhead

void moveProcessProcessorAhead(Id processProcessorId,
 Id processId,
 Id referenceId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders process processors for a process by moving the specified process processor in front of a reference process processor.

Parameters:

processProcessorId - the Id of the ProcessProcessor

processId - the Id of the Process

referenceId - the reference process processor Id

Throws:

NotFoundException - processProcessorId processId, or referenceId not found or, processProcessorId or referenceId not related to processId

NullArgumentException - processProcessorId, processId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveProcessProcessorBehind

void moveProcessProcessorBehind(Id processProcessorId,
 Id processId,
 Id referenceId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders process processors for a process by moving the specified process processor behind a reference process processor.

Parameters:

processProcessorId - the Id of the ProcessProcessor

processId - the Id of the Process

referenceId - the reference process processor Id

Throws:

NotFoundException - processProcessorId, processId, or referenceId not found or, processProcessorId or referenceId not related to processId

NullArgumentException - processProcessorId, processId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderProcessProcessors

void orderProcessProcessors(Id[] processProcessorIds,
 Id processId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of process processors for a process.

Parameters:

processProcessorIds - the Ids for a set of ProcessProcessors

processId - the Id of the Process

Throws:

NotFoundException - processId not found or, a processProcessorId not related to processId

NullArgumentException - processProcessorIds or processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.