Interface StepProcessorRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface StepProcessorRuleApplicationSession
extends OsidSession

This session provides methods to apply StepProcessors to Steps .

Method Summary

Modifier and Type	Method	Description
void	assignStepProcessorToStep(Id stepProcessorId, Id stepId)	Adds an existing StepProcessor to a Step .
boolean	canAssignStepProcessors()	Tests if this user can alter step processor/step mappings.
boolean	canSequenceStepProcessors()	Tests if this user can order StepProcessors .
Office	getOffice()	Gets the Office associated with this session.
Id	getOfficeId()	Gets the Office Id associated with this session.
void	moveStepProcessorAhead(Id stepProcessorId, Id stepId, Id referenceId)	Reorders step processors for a step by moving the specified step processors in front of a reference step processors.
void	moveStepProcessorBehind(Id stepProcessorId, Id stepId, Id referenceId)	Reorders step processors for a step by moving the specified step processors behind a reference step processors.
void	orderStepProcessors(Id[] stepProcessorIds, Id stepId)	Reorders a set of step processors for a step.
void	unassignStepProcessorFromStep(Id stepProcessorId, Id stepId)	Removes a StepProcessor from a Step .

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.

canAssignStepProcessors

boolean canAssignStepProcessors()

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

assignStepProcessorToStep

void assignStepProcessorToStep(Id stepProcessorId,
 Id stepId)
                        throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing StepProcessor to a Step .

Parameters:

stepProcessorId - the Id of the StepProcessor

stepId - the Id of the Step

Throws:

AlreadyExistsException - stepProcessorId is already applied to stepId

NotFoundException - stepProcessorId or stepId not found

NullArgumentException - stepProcessorId or stepId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignStepProcessorFromStep

void unassignStepProcessorFromStep(Id stepProcessorId,
 Id stepId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a StepProcessor from a Step .

Parameters:

stepProcessorId - the Id of the StepProcessor

stepId - the Id of the Step

Throws:

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

NullArgumentException - stepProcessorId or stepId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceStepProcessors

boolean canSequenceStepProcessors()

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

Compliance:

mandatory - This method must be implemented.

moveStepProcessorAhead

void moveStepProcessorAhead(Id stepProcessorId,
 Id stepId,
 Id referenceId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders step processors for a step by moving the specified step processors in front of a reference step processors.

Parameters:

stepProcessorId - the Id of a StepProcessor

stepId - the Id of a Step

referenceId - the reference step processor Id

Throws:

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

NullArgumentException - stepProcessorId, stepId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveStepProcessorBehind

void moveStepProcessorBehind(Id stepProcessorId,
 Id stepId,
 Id referenceId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders step processors for a step by moving the specified step processors behind a reference step processors.

Parameters:

stepProcessorId - the Id of a StepProcessor

stepId - the Id of a Step

referenceId - the reference step processor Id

Throws:

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

NullArgumentException - stepProcessorId, stepId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderStepProcessors

void orderStepProcessors(Id[] stepProcessorIds,
 Id stepId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of step processors for a step.

Parameters:

stepProcessorIds - the Ids for a set of StepProcessors

stepId - the Id of a Step

Throws:

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

NullArgumentException - stepProcessorIds or stepId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.