Interface ProcessEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ProcessEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply ProcessEnablers to Processs . A Process with multiple ProcessEnablers means any positive rule evaluation across the constrainers result in an accessible Process .

Method Summary

Modifier and Type	Method	Description
void	assignProcessEnablerToProcess(Id processEnablerId, Id processId)	Adds an existing ProcessEnabler to a Process .
boolean	canAssignProcessEnablers()	Tests if this user can alter process enabler/process mappings.
boolean	canSequenceProcessEnablers()	Tests if this user can order ProcessEnablers .
Office	getOffice()	Gets the Office associated with this session.
Id	getOfficeId()	Gets the Office Id associated with this session.
void	moveProcessEnablerAhead(Id processEnablerId, Id processId, Id referenceId)	Reorders process enablers for a process by moving the specified process enabler in front of a reference process enabler.
void	moveProcessEnablerBehind(Id processEnablerId, Id processId, Id referenceId)	Reorders process enablers for a process by moving the specified process enabler behind a reference process enabler.
void	orderProcessEnablers(Id[] processEnablerIds, Id processId)	Reorders a set of process enablers for a process.
void	unassignProcessEnablerFromProcess(Id processEnablerId, Id processId)	Removes a ProcessEnabler 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.

canAssignProcessEnablers

boolean canAssignProcessEnablers()

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

assignProcessEnablerToProcess

void assignProcessEnablerToProcess(Id processEnablerId,
 Id processId)
                            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing ProcessEnabler to a Process .

Parameters:

processEnablerId - the Id of the ProcessEnabler

processId - the Id of the Process

Throws:

AlreadyExistsException - processEnablerId is already applied to processId

NotFoundException - processEnablerId or processId not found

NullArgumentException - processEnablerId or processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignProcessEnablerFromProcess

void unassignProcessEnablerFromProcess(Id processEnablerId,
 Id processId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a ProcessEnabler from a Process .

Parameters:

processEnablerId - the Id of the ProcessEnabler

processId - the Id of the Process

Throws:

NotFoundException - processEnablerId or processId not found or processEnablerId not applied to processId

NullArgumentException - processEnablerId or processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceProcessEnablers

boolean canSequenceProcessEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveProcessEnablerAhead

void moveProcessEnablerAhead(Id processEnablerId,
 Id processId,
 Id referenceId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders process enablers for a process by moving the specified process enabler in front of a reference process enabler.

Parameters:

processEnablerId - the Id of a ProcessEnabler

processId - the Id of a Process

referenceId - the reference process enabler Id

Throws:

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

NullArgumentException - processEnablerId, processId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveProcessEnablerBehind

void moveProcessEnablerBehind(Id processEnablerId,
 Id processId,
 Id referenceId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders process enablers for a process by moving the specified process enabler behind a reference process enabler.

Parameters:

processEnablerId - the Id of a ProcessEnabler

processId - the Id of a Process

referenceId - the reference process enabler Id

Throws:

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

NullArgumentException - processEnablerId, processId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderProcessEnablers

void orderProcessEnablers(Id[] processEnablerIds,
 Id processId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of process enablers for a process.

Parameters:

processEnablerIds - the Ids for a set of ProcessEnablers

processId - the Id of a Process

Throws:

NotFoundException - processId not found or, an processEnablerId not related to processId

NullArgumentException - processEnabelrIds or processId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.