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.
Modifier and Type | Method and 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. |
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 canAssignStepConstrainerEnablers()
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 assignStepConstrainerEnablerToStepConstrainer(Id stepConstrainerEnablerId, Id stepConstrainerId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
StepConstrainerEnabler
to a
StepConstrainer.
stepConstrainerEnablerId
- the Id
of the
StepConstrainerEnabler
stepConstrainerId
- the Id
of the
StepConstrainer
AlreadyExistsException
-
stepConstrainerEnablerId
is already applied to
stepConstrainerId
NotFoundException
- stepConstrainerEnablerId
or stepConstrainerId
not foundNullArgumentException
- stepConstrainerEnablerId
or stepConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignStepConstrainerEnablerFromStepConstrainer(Id stepConstrainerEnablerId, Id stepConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
StepConstrainerEnabler
from a
StepConstrainer.
stepConstrainerEnablerId
- the Id
of the
StepConstrainerEnabler
stepConstrainerId
- the Id
of the
StepConstrainer
NotFoundException
- stepConstrainerEnablerId
or stepConstrainerId
not found or
stepConstrainerEnablerId
not applied to
stepConstrainerId
NullArgumentException
- stepConstrainerEnablerId
or stepConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceStepConstrainerEnablers()
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. false
if StepConstrainerEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveStepConstrainerEnablerAhead(Id stepConstrainerEnablerId, Id stepConstrainerId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
stepConstrainerEnablerId
- the Id
of a
StepConstrainerEnabler
stepConstrainerId
- the Id
of a
StepConstrainer
referenceId
- the reference step constrainer enabler Id
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 requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveStepConstrainerEnablerBehind(Id stepConstrainerEnablerId, Id stepConstrainerId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
stepConstrainerEnablerId
- the Id
of a
StepConstrainerEnabler
stepConstrainerId
- the Id
of a
StepConstrainer
referenceId
- the reference step constrainer enabler Id
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 requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderStepConstrainerEnablers(Id[] stepConstrainerEnablerIds, Id stepConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
stepConstrainerEnablerIds
- the Ids
for a set of
StepConstrainerEnablers
stepConstrainerId
- the Id
of a
StepConstrainer
NotFoundException
- stepConstrainerId
not found or, an stepConstrainerEnablerId
not
related to stepConstrainerId
NullArgumentException
-
stepConstrainerEnablerIds
or stepConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.