Interface ProcessProcessorEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ProcessProcessorEnablerRuleApplicationSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	assignProcessProcessorEnablerToProcessProcessor(Id processProcessorEnablerId, Id processProcessorId)	Adds an existing ProcessProcessorEnabler to a ProcessProcessor.
boolean	canAssignProcessProcessorEnablers()	Tests if this user can alter process processor enabler/process processor mappings.
boolean	canSequenceProcessProcessorEnablers()	Tests if this user can order ProcessProcessorEnablers.
Office	getOffice()	Gets the Office associated with this session.
Id	getOfficeId()	Gets the Office Id associated with this session.
void	moveProcessProcessorEnablerAhead(Id processProcessorEnablerId, Id processProcessorId, Id referenceId)	Reorders process processor enablers for a process processor by moving the specified process processor enabler in front of a reference process processor enabler.
void	moveProcessProcessorEnablerBehind(Id processProcessorEnablerId, Id processProcessorId, Id referenceId)	Reorders process processor enablers for a process processor by moving the specified process processor enabler behind a reference process processor enabler.
void	orderProcessProcessorEnablers(Id[] processProcessorEnablerIds, Id processProcessorId)	Reorders a set of process processor enablers for a process processor.
void	unassignProcessProcessorEnablerFromProcessProcessor(Id processProcessorEnablerId, Id processProcessorId)	Removes an existing ProcessProcessorEnabler from a ProcessProcessor.

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.

canAssignProcessProcessorEnablers

boolean canAssignProcessProcessorEnablers()

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

assignProcessProcessorEnablerToProcessProcessor

void assignProcessProcessorEnablerToProcessProcessor(Id processProcessorEnablerId,
 Id processProcessorId)
                                              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing ProcessProcessorEnabler to a ProcessProcessor.

Parameters:

processProcessorEnablerId - the Id of the ProcessProcessorEnabler

processProcessorId - the Id of the ProcessProcessor

Throws:

AlreadyExistsException - processProcessorEnablerId already applied to processProcessorId

NotFoundException - processProcessorEnablerId or processProcessorId not found

NullArgumentException - processProcessorEnablerId or processProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignProcessProcessorEnablerFromProcessProcessor

void unassignProcessProcessorEnablerFromProcessProcessor(Id processProcessorEnablerId,
 Id processProcessorId)
                                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing ProcessProcessorEnabler from a ProcessProcessor.

Parameters:

processProcessorEnablerId - the Id of the ProcessProcessorEnabler

processProcessorId - the Id of the ProcessProcessor

Throws:

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

NullArgumentException - processProcessorEnablerId or processProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceProcessProcessorEnablers

boolean canSequenceProcessProcessorEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveProcessProcessorEnablerAhead

void moveProcessProcessorEnablerAhead(Id processProcessorEnablerId,
 Id processProcessorId,
 Id referenceId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

processProcessorEnablerId - the Id of the ProcessProcessorEnabler

processProcessorId - the Id of the ProcessProcessor

referenceId - the reference process processor enabler Id

Throws:

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

NullArgumentException - processProcessorEnablerId, processProcessorId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveProcessProcessorEnablerBehind

void moveProcessProcessorEnablerBehind(Id processProcessorEnablerId,
 Id processProcessorId,
 Id referenceId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

processProcessorEnablerId - the Id of the ProcessProcessorEnabler

processProcessorId - the Id of the ProcessProcessor

referenceId - the reference process processor Id

Throws:

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

NullArgumentException - processProcessorEnablerId, processProcessorId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderProcessProcessorEnablers

void orderProcessProcessorEnablers(Id[] processProcessorEnablerIds,
 Id processProcessorId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of process processor enablers for a process processor.

Parameters:

processProcessorEnablerIds - the Ids for a set of ProcessProcessorEnablers

processProcessorId - the Id of the ProcessProcessor

Throws:

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

NullArgumentException - processProcessorEnablerIds or processProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.