Interface StepProcessorEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface StepProcessorEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply StepProcessorEnablers to StepProcessors . a StepProcessor with multiple StepProcessorEnablers means any positive rule evaluation across the enablers result in an effective StepProcessor .

Method Summary

Modifier and Type	Method	Description
void	assignStepProcessorEnablerToStepProcessor(Id stepProcessorEnablerId, Id stepProcessorId)	Adds an existing StepProcessorEnabler to a StepProcessor .
boolean	canAssignStepProcessorEnablers()	Tests if this user can alter step processor enabler/step processor mappings.
boolean	canSequenceStepProcessorEnablers()	Tests if this user can order StepProcessorEnablers .
Office	getOffice()	Gets the Office associated with this session.
Id	getOfficeId()	Gets the Office Id associated with this session.
void	moveStepProcessorEnablerAhead(Id stepProcessorEnablerId, Id stepProcessorId, Id referenceId)	Reorders step processor enablers for a step processor by moving the specified step processor enabler in front of a reference step processor enabler.
void	moveStepProcessorEnablerBehind(Id stepProcessorEnablerId, Id stepProcessorId, Id referenceId)	Reorders step processor enablers for a step processor by moving the specified step processor enabler behind a reference step processor enabler.
void	orderStepProcessorEnablers(Id[] stepProcessorEnablerIds, Id stepProcessorId)	Reorders a set of step processor enablers for a step processor.
void	unassignStepProcessorEnablerFromStepProcessor(Id stepProcessorEnablerId, Id stepProcessorId)	Removes a StepProcessorEnabler from a StepProcessor .

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.

canAssignStepProcessorEnablers

boolean canAssignStepProcessorEnablers()

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

assignStepProcessorEnablerToStepProcessor

void assignStepProcessorEnablerToStepProcessor(Id stepProcessorEnablerId,
 Id stepProcessorId)
                                        throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing StepProcessorEnabler to a StepProcessor .

Parameters:

stepProcessorEnablerId - the Id of the StepProcessorEnabler

stepProcessorId - the Id of the StepProcessor

Throws:

AlreadyExistsException - stepProcessorEnablerId is already applied to stepProcessorId

NotFoundException - stepProcessorEnablerId or stepProcessorId not found

NullArgumentException - stepProcessorEnablerId or stepProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignStepProcessorEnablerFromStepProcessor

void unassignStepProcessorEnablerFromStepProcessor(Id stepProcessorEnablerId,
 Id stepProcessorId)
                                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a StepProcessorEnabler from a StepProcessor .

Parameters:

stepProcessorEnablerId - the Id of the StepProcessorEnabler

stepProcessorId - the Id of the StepProcessor

Throws:

NotFoundException - stepProcessorEnablerId or stepProcessorId not found or stepProcessorEnablerId not applied to stepProcessorId

NullArgumentException - stepProcessorEnablerId or stepProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceStepProcessorEnablers

boolean canSequenceStepProcessorEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveStepProcessorEnablerAhead

void moveStepProcessorEnablerAhead(Id stepProcessorEnablerId,
 Id stepProcessorId,
 Id referenceId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

stepProcessorEnablerId - the Id of a StepProcessorEnabler

stepProcessorId - the Id of a StepProcessor

referenceId - the reference step processor enabler Id

Throws:

NotFoundException - stepProcessorEnablerId, stepProcessorId , or referenceId not found or, stepProcessorEnablerId or referenceId not related to stepProcessorId

NullArgumentException - stepProcessorEnablerId, stepProcessorId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveStepProcessorEnablerBehind

void moveStepProcessorEnablerBehind(Id stepProcessorEnablerId,
 Id stepProcessorId,
 Id referenceId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

stepProcessorEnablerId - the Id of a StepProcessorEnabler

stepProcessorId - the Id of a StepProcessor

referenceId - the reference step processor enabler Id

Throws:

NotFoundException - stepProcessorEnablerId, stepProcessorId , or referenceId not found or, stepProcessorEnablerId or referenceId not related to stepProcessorId

NullArgumentException - stepProcessorEnablerId, stepProcessorId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderStepProcessorEnablers

void orderStepProcessorEnablers(Id[] stepProcessorEnablerIds,
 Id stepProcessorId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

stepProcessorEnablerIds - the Ids for a set of StepProcessorEnablers

stepProcessorId - the Id of a StepProcessor

Throws:

NotFoundException - stepProcessorId not found or, an stepProcessorEnablerId not related to stepProcessorId

NullArgumentException - stepProcessorEnablerIds or stepProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.