Interface StepEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface StepEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply StepEnablers to Steps. Multiple StepEnablers applied to an Step may be sequenced such that the first positive evaluation results in the StepEnablers used.

Method Summary

Modifier and Type	Method	Description
void	assignStepEnablerToStep(Id stepEnablerId, Id stepId)	Adds an existing StepEnabler to a Step.
boolean	canAssignStepEnablers()	Tests if this user can alter step enabler/step mappings.
boolean	canSequenceStepEnablers()	Tests if this user can order StepEnablers.
Office	getOffice()	Gets the Office associated with this session.
Id	getOfficeId()	Gets the Office Id associated with this session.
void	moveStepEnablerAhead(Id stepEnablerId, Id stepId, Id referenceId)	Reorders step enablers for a step by moving the specified step enabler in front of a reference step enabler.
void	moveStepEnablerBehind(Id stepEnablerId, Id stepId, Id referenceId)	Reorders step enablers for a step by moving the specified step enabler behind a reference step enabler.
void	orderStepEnablers(Id[] stepEnablerIds, Id stepId)	Reorders a set of step enablers for a step.
void	unassignStepEnablerFromStep(Id stepEnablerId, Id stepId)	Removes an existing StepEnabler 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.

canAssignStepEnablers

boolean canAssignStepEnablers()

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

assignStepEnablerToStep

void assignStepEnablerToStep(Id stepEnablerId,
 Id stepId)
                      throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing StepEnabler to a Step.

Parameters:

stepEnablerId - the Id of the StepEnabler

stepId - the Id of the Step

Throws:

AlreadyExistsException - stepEnablerId already applied to stepId

NotFoundException - stepEnablerId or stepId not found

NullArgumentException - stepEnablerId or stepId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignStepEnablerFromStep

void unassignStepEnablerFromStep(Id stepEnablerId,
 Id stepId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing StepEnabler from a Step.

Parameters:

stepEnablerId - the Id of the StepEnabler

stepId - the Id of the Step

Throws:

NotFoundException - stepEnablerId or stepId not found or stepEnablerId already applied to stepId

NullArgumentException - stepEnablerId or stepId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceStepEnablers

boolean canSequenceStepEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveStepEnablerAhead

void moveStepEnablerAhead(Id stepEnablerId,
 Id stepId,
 Id referenceId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

stepEnablerId - the Id of the StepEnabler

stepId - the Id of the Step

referenceId - the reference step enabler Id

Throws:

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

NullArgumentException - stepEnablerId, stepId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveStepEnablerBehind

void moveStepEnablerBehind(Id stepEnablerId,
 Id stepId,
 Id referenceId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

stepEnablerId - the Id of the StepEnabler

stepId - the Id of the Step

referenceId - the reference step enabler Id

Throws:

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

NullArgumentException - stepEnablerId, stepId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderStepEnablers

void orderStepEnablers(Id[] stepEnablerIds,
 Id stepId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of step enablers for a step.

Parameters:

stepEnablerIds - the Ids for a set of StepEnablers

stepId - the Id of the Step

Throws:

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

NullArgumentException - stepEnablerIds, stepId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.