Interface StepConstrainerEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface StepConstrainerEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply StepConstrainerEnablers to StepConstrainers . a StepConstrainer with multiple StepConstrainerEnablers means any positive rule evaluation across the enablers result in an effective StepConstrainer .

Method Summary

Modifier and Type	Method	Description
void	assignStepConstrainerEnablerToStepConstrainer(Id stepConstrainerEnablerId, Id stepConstrainerId)	Adds an existing StepConstrainerEnabler to a StepConstrainer .
boolean	canAssignStepConstrainerEnablers()	Tests if this user can alter step constrainer enabler/step constrainer mappings.
boolean	canSequenceStepConstrainerEnablers()	Tests if this user can order StepConstrainerEnablers .
Office	getOffice()	Gets the Office associated with this session.
Id	getOfficeId()	Gets the Office Id associated with this session.
void	moveStepConstrainerEnablerAhead(Id stepConstrainerEnablerId, Id stepConstrainerId, Id referenceId)	Reorders step constrainer enablers for a step constrainer by moving the specified step constrainer enabler in front of a reference step constrainer enabler.
void	moveStepConstrainerEnablerBehind(Id stepConstrainerEnablerId, Id stepConstrainerId, Id referenceId)	Reorders step constrainer enablers for a step constrainer by moving the specified step constrainer enabler behind a reference step constrainer enabler.
void	orderStepConstrainerEnablers(Id[] stepConstrainerEnablerIds, Id stepConstrainerId)	Reorders a set of step constrainer enablers for a step constrainer.
void	unassignStepConstrainerEnablerFromStepConstrainer(Id stepConstrainerEnablerId, Id stepConstrainerId)	Removes a StepConstrainerEnabler from a StepConstrainer .

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.

canAssignStepConstrainerEnablers

boolean canAssignStepConstrainerEnablers()

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

assignStepConstrainerEnablerToStepConstrainer

void assignStepConstrainerEnablerToStepConstrainer(Id stepConstrainerEnablerId,
 Id stepConstrainerId)
                                            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing StepConstrainerEnabler to a StepConstrainer .

Parameters:

stepConstrainerEnablerId - the Id of the StepConstrainerEnabler

stepConstrainerId - the Id of the StepConstrainer

Throws:

AlreadyExistsException - stepConstrainerEnablerId is already applied to stepConstrainerId

NotFoundException - stepConstrainerEnablerId or stepConstrainerId not found

NullArgumentException - stepConstrainerEnablerId or stepConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignStepConstrainerEnablerFromStepConstrainer

void unassignStepConstrainerEnablerFromStepConstrainer(Id stepConstrainerEnablerId,
 Id stepConstrainerId)
                                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a StepConstrainerEnabler from a StepConstrainer .

Parameters:

stepConstrainerEnablerId - the Id of the StepConstrainerEnabler

stepConstrainerId - the Id of the StepConstrainer

Throws:

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

NullArgumentException - stepConstrainerEnablerId or stepConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceStepConstrainerEnablers

boolean canSequenceStepConstrainerEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveStepConstrainerEnablerAhead

void moveStepConstrainerEnablerAhead(Id stepConstrainerEnablerId,
 Id stepConstrainerId,
 Id referenceId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

stepConstrainerEnablerId - the Id of a StepConstrainerEnabler

stepConstrainerId - the Id of a StepConstrainer

referenceId - the reference step constrainer enabler Id

Throws:

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

NullArgumentException - stepConstrainerEnablerId, stepConstrainerId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveStepConstrainerEnablerBehind

void moveStepConstrainerEnablerBehind(Id stepConstrainerEnablerId,
 Id stepConstrainerId,
 Id referenceId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

stepConstrainerEnablerId - the Id of a StepConstrainerEnabler

stepConstrainerId - the Id of a StepConstrainer

referenceId - the reference step constrainer enabler Id

Throws:

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

NullArgumentException - stepConstrainerEnablerId, stepConstrainerId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderStepConstrainerEnablers

void orderStepConstrainerEnablers(Id[] stepConstrainerEnablerIds,
 Id stepConstrainerId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

stepConstrainerEnablerIds - the Ids for a set of StepConstrainerEnablers

stepConstrainerId - the Id of a StepConstrainer

Throws:

NotFoundException - stepConstrainerId not found or, an stepConstrainerEnablerId not related to stepConstrainerId

NullArgumentException - stepConstrainerEnablerIds or stepConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.