Interface StepConstrainerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface StepConstrainerRuleApplicationSession
extends OsidSession

This session provides methods to apply StepConstrainers to Steps . A Step with multiple StepConstrainers means any positive rule evaluation across the constrainers result in an accessible Step .

Method Summary

Modifier and Type	Method	Description
void	assignStepConstrainerToStep(Id stepConstrainerId, Id stepId)	Adds an existing StepConstrainer to a Step .
boolean	canAssignStepConstrainers()	Tests if this user can alter step constrainer/step mappings.
boolean	canSequenceStepConstrainers()	Tests if this user can order StepConstrainers .
Office	getOffice()	Gets the Office associated with this session.
Id	getOfficeId()	Gets the Office Id associated with this session.
void	moveStepConstrainerAhead(Id stepConstrainerId, Id stepId, Id referenceId)	Reorders step constrainer for a step by moving the specified step constrainer in front of a reference step constrainer.
void	moveStepConstrainerBehind(Id stepConstrainerId, Id stepId, Id referenceId)	Reorders step constrainer for a step by moving the specified step constrainer behind a reference step constrainer.
void	orderStepConstrainers(Id[] stepConstrainerIds, Id stepId)	Reorders a set of step constrainers for a step.
void	unassignStepConstrainerFromStep(Id stepConstrainerId, Id stepId)	Removes a StepConstrainer 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.

canAssignStepConstrainers

boolean canAssignStepConstrainers()

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

assignStepConstrainerToStep

void assignStepConstrainerToStep(Id stepConstrainerId,
 Id stepId)
                          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing StepConstrainer to a Step .

Parameters:

stepConstrainerId - the Id of the StepConstrainer

stepId - the Id of the Step

Throws:

AlreadyExistsException - stepConstrainerId is already applied to stepId

NotFoundException - stepConstrainerId or stepId not found

NullArgumentException - stepConstrainerId or stepId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignStepConstrainerFromStep

void unassignStepConstrainerFromStep(Id stepConstrainerId,
 Id stepId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a StepConstrainer from a Step .

Parameters:

stepConstrainerId - the Id of the StepConstrainer

stepId - the Id of the Step

Throws:

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

NullArgumentException - stepConstrainerId or stepId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceStepConstrainers

boolean canSequenceStepConstrainers()

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

Compliance:

mandatory - This method must be implemented.

moveStepConstrainerAhead

void moveStepConstrainerAhead(Id stepConstrainerId,
 Id stepId,
 Id referenceId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

stepConstrainerId - the Id of a StepConstrainer

stepId - the Id of a Step

referenceId - the reference step constrainer Id

Throws:

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

NullArgumentException - stepConstrainerId, stepId or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveStepConstrainerBehind

void moveStepConstrainerBehind(Id stepConstrainerId,
 Id stepId,
 Id referenceId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

stepConstrainerId - the Id of a StepConstrainer

stepId - the Id of a Step

referenceId - the reference step constrainer Id

Throws:

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

NullArgumentException - stepConstrainerId, stepId or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderStepConstrainers

void orderStepConstrainers(Id[] stepConstrainerIds,
 Id stepId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of step constrainers for a step.

Parameters:

stepConstrainerIds - the Ids for a set of StepConstrainers

stepId - the Id of a StepConstrainer

Throws:

NotFoundException - stepId not found or, a stepConstrainerId not related to stepId

NullArgumentException - stepConstrainerIds or stepId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.