Interface ProcessConstrainerEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ProcessConstrainerEnablerRuleApplicationSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	assignProcessConstrainerEnablerToProcessConstrainer(Id processConstrainerEnablerId, Id processConstrainerId)	Adds an existing ProcessConstrainerEnabler to a ProcessConstrainer.
boolean	canAssignProcessConstrainerEnablers()	Tests if this user can alter process constrainer enabler/process constrainer mappings.
boolean	canSequenceProcessConstrainerEnablers()	Tests if this user can order ProcessConstrainerEnablers.
Office	getOffice()	Gets the Office associated with this session.
Id	getOfficeId()	Gets the Office Id associated with this session.
void	moveProcessConstrainerEnablerAhead(Id processConstrainerEnablerId, Id processConstrainerId, Id referenceId)	Reorders process constrainer enablers for a process constrainer by moving the specified process constrainer enabler in front of a reference process constrainer enabler.
void	moveProcessConstrainerEnablerBehind(Id processConstrainerEnablerId, Id processConstrainerId, Id referenceId)	Reorders process constrainer enablers for a process constrainer by moving the specified process constrainer enabler behind a reference process constrainer enabler.
void	orderProcessConstrainerEnablers(Id[] processConstrainerEnablerIds, Id processConstrainerId)	Reorders a set of process constrainer enablers for a process constrainer.
void	unassignProcessConstrainerEnablerFromProcessConstrainer(Id processConstrainerEnablerId, Id processConstrainerId)	Removes an existing ProcessConstrainerEnabler from a ProcessConstrainer.

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.

canAssignProcessConstrainerEnablers

boolean canAssignProcessConstrainerEnablers()

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

assignProcessConstrainerEnablerToProcessConstrainer

void assignProcessConstrainerEnablerToProcessConstrainer(Id processConstrainerEnablerId,
 Id processConstrainerId)
                                                  throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing ProcessConstrainerEnabler to a ProcessConstrainer.

Parameters:

processConstrainerEnablerId - the Id of the ProcessConstrainerEnabler

processConstrainerId - the Id of the ProcessConstrainer

Throws:

AlreadyExistsException - processConstrainerEnablerId already applied to processConstrainerId

NotFoundException - processConstrainerEnablerId or processConstrainerId not found

NullArgumentException - processConstrainerEnablerId or processConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignProcessConstrainerEnablerFromProcessConstrainer

void unassignProcessConstrainerEnablerFromProcessConstrainer(Id processConstrainerEnablerId,
 Id processConstrainerId)
                                                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing ProcessConstrainerEnabler from a ProcessConstrainer.

Parameters:

processConstrainerEnablerId - the Id of the ProcessConstrainerEnabler

processConstrainerId - the Id of the ProcessConstrainer

Throws:

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

NullArgumentException - processConstrainerEnablerId or processConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceProcessConstrainerEnablers

boolean canSequenceProcessConstrainerEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveProcessConstrainerEnablerAhead

void moveProcessConstrainerEnablerAhead(Id processConstrainerEnablerId,
 Id processConstrainerId,
 Id referenceId)
                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

processConstrainerEnablerId - the Id of the ProcessConstrainerEnabler

processConstrainerId - the Id of the ProcessConstrainer

referenceId - the reference process constrainer enabler Id

Throws:

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

NullArgumentException - processConstrainerEnablerId, processConstrainerId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveProcessConstrainerEnablerBehind

void moveProcessConstrainerEnablerBehind(Id processConstrainerEnablerId,
 Id processConstrainerId,
 Id referenceId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

processConstrainerEnablerId - the Id of the ProcessConstrainerEnabler

processConstrainerId - the Id of the ProcessConstrainer

referenceId - the reference process constrainer Id

Throws:

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

NullArgumentException - processConstrainerEnablerId, processConstrainerId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderProcessConstrainerEnablers

void orderProcessConstrainerEnablers(Id[] processConstrainerEnablerIds,
 Id processConstrainerId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

processConstrainerEnablerIds - the Ids for a set of ProcessConstrainerEnablers

processConstrainerId - the Id of the ProcessConstrainer

Throws:

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

NullArgumentException - processConstrainerEnablerIds or processConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.