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.
Modifier and Type | Method and 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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getOfficeId()
Office
Id
associated with this
session. Office Id
associated with this sessionmandatory
- This method must be implemented. Office getOffice() throws OperationFailedException, PermissionDeniedException
Office
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAssignStepConstrainers()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. void assignStepConstrainerToStep(Id stepConstrainerId, Id stepId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
StepConstrainer
to a Step.
stepConstrainerId
- the Id
of the
StepConstrainer
stepId
- the Id
of the Step
AlreadyExistsException
- stepConstrainerId
is already applied to stepId
NotFoundException
- stepConstrainerId
or
stepId
not foundNullArgumentException
- stepConstrainerId
or stepId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignStepConstrainerFromStep(Id stepConstrainerId, Id stepId) throws NotFoundException, OperationFailedException, PermissionDeniedException
StepConstrainer
from a Step.
stepConstrainerId
- the Id
of the
StepConstrainer
stepId
- the Id
of the Step
NotFoundException
- stepConstrainerId
or
stepId
not found or stepConstrainerId
not applied to stepId
NullArgumentException
- stepConstrainerId
or stepId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceStepConstrainers()
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. false
if StepConstrainer
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveStepConstrainerAhead(Id stepConstrainerId, Id stepId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
stepConstrainerId
- the Id
of a
StepConstrainer
stepId
- the Id
of a Step
referenceId
- the reference step constrainer Id
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 requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveStepConstrainerBehind(Id stepConstrainerId, Id stepId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
stepConstrainerId
- the Id
of a
StepConstrainer
stepId
- the Id
of a Step
referenceId
- the reference step constrainer Id
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 requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderStepConstrainers(Id[] stepConstrainerIds, Id stepId) throws NotFoundException, OperationFailedException, PermissionDeniedException
stepConstrainerIds
- the Ids
for a set of
StepConstrainers
stepId
- the Id
of a StepConstrainer
NotFoundException
- stepId
not found or,
a stepConstrainerId
not related to
stepId
NullArgumentException
- stepConstrainerIds
or stepId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.