Interface ProcessConstrainerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ProcessConstrainerRuleApplicationSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	assignProcessConstrainerToProcess(Id processConstrainerId, Id processId)	Adds an existing ProcessConstrainer to a Process.
boolean	canAssignProcessConstrainers()	Tests if this user can alter process constrainer/process mappings.
boolean	canSequenceProcessConstrainers()	Tests if this user can order ProcessConstrainers.
Office	getOffice()	Gets the Office associated with this session.
Id	getOfficeId()	Gets the Office Id associated with this session.
void	moveProcessConstrainerAhead(Id processConstrainerId, Id processId, Id referenceId)	Reorders process constrainers for a process by moving the specified process constrainer in front of a reference process constrainer.
void	moveProcessConstrainerBehind(Id processConstrainerId, Id processId, Id referenceId)	Reorders process constrainers for a process by moving the specified process constrainer behind a reference process constrainer.
void	orderProcessConstrainers(Id[] processConstrainerIds, Id processId)	Reorders a set of process constrainers for a process.
void	unassignProcessConstrainerFromProcess(Id processConstrainerId, Id processId)	Removes an existing ProcessConstrainer 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.

canAssignProcessConstrainers

boolean canAssignProcessConstrainers()

Tests if this user can alter process constrainer/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.

assignProcessConstrainerToProcess

void assignProcessConstrainerToProcess(Id processConstrainerId,
 Id processId)
                                throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing ProcessConstrainer to a Process.

Parameters:

processConstrainerId - the Id of the ProcessConstrainer

processId - the Id of the Process

Throws:

AlreadyExistsException - processConstrainerId already applied to processId

NotFoundException - processConstrainerId or processId not found

NullArgumentException - processConstrainerId or processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignProcessConstrainerFromProcess

void unassignProcessConstrainerFromProcess(Id processConstrainerId,
 Id processId)
                                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing ProcessConstrainer from a Process.

Parameters:

processConstrainerId - the Id of the ProcessConstrainer

processId - the Id of the Process

Throws:

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

NullArgumentException - processConstrainerId or processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceProcessConstrainers

boolean canSequenceProcessConstrainers()

Tests if this user can order ProcessConstrainers. 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 ProcessConstrainer ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveProcessConstrainerAhead

void moveProcessConstrainerAhead(Id processConstrainerId,
 Id processId,
 Id referenceId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders process constrainers for a process by moving the specified process constrainer in front of a reference process constrainer.

Parameters:

processConstrainerId - the Id of the ProcessConstrainer

processId - the Id of the Process

referenceId - the reference process constrainer Id

Throws:

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

NullArgumentException - processConstrainerId, processId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveProcessConstrainerBehind

void moveProcessConstrainerBehind(Id processConstrainerId,
 Id processId,
 Id referenceId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders process constrainers for a process by moving the specified process constrainer behind a reference process constrainer.

Parameters:

processConstrainerId - the Id of the ProcessConstrainer

processId - the Id of the Process

referenceId - the reference process constrainer Id

Throws:

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

NullArgumentException - processConstrainerId, processId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderProcessConstrainers

void orderProcessConstrainers(Id[] processConstrainerIds,
 Id processId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of process constrainers for a process.

Parameters:

processConstrainerIds - the Ids for a set of ProcessConstrainers

processId - the Id of the Process

Throws:

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

NullArgumentException - processConstrainerIds or processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.