public interface StepProcessorEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply StepProcessorEnablers
to StepProcessors.
a StepProcessor
with multiple StepProcessorEnablers
means any positive rule
evaluation across the enablers result in an effective
StepProcessor.
Modifier and Type | Method and Description |
---|---|
void |
assignStepProcessorEnablerToStepProcessor(Id stepProcessorEnablerId,
Id stepProcessorId)
Adds an existing
StepProcessorEnabler to a
StepProcessor. |
boolean |
canAssignStepProcessorEnablers()
Tests if this user can alter step processor enabler/step processor
mappings.
|
boolean |
canSequenceStepProcessorEnablers()
Tests if this user can order
StepProcessorEnablers. |
Office |
getOffice()
Gets the
Office associated with this session. |
Id |
getOfficeId()
Gets the
Office Id associated with this
session. |
void |
moveStepProcessorEnablerAhead(Id stepProcessorEnablerId,
Id stepProcessorId,
Id referenceId)
Reorders step processor enablers for a step processor by moving the
specified step processor enabler in front of a reference step
processor enabler.
|
void |
moveStepProcessorEnablerBehind(Id stepProcessorEnablerId,
Id stepProcessorId,
Id referenceId)
Reorders step processor enablers for a step processor by moving the
specified step processor enabler behind a reference step processor
enabler.
|
void |
orderStepProcessorEnablers(Id[] stepProcessorEnablerIds,
Id stepProcessorId)
Reorders a set of step processor enablers for a step processor.
|
void |
unassignStepProcessorEnablerFromStepProcessor(Id stepProcessorEnablerId,
Id stepProcessorId)
Removes a
StepProcessorEnabler from a
StepProcessor. |
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 canAssignStepProcessorEnablers()
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 assignStepProcessorEnablerToStepProcessor(Id stepProcessorEnablerId, Id stepProcessorId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
StepProcessorEnabler
to a
StepProcessor.
stepProcessorEnablerId
- the Id
of the
StepProcessorEnabler
stepProcessorId
- the Id
of the
StepProcessor
AlreadyExistsException
- stepProcessorEnablerId
is already applied to stepProcessorId
NotFoundException
- stepProcessorEnablerId
or stepProcessorId
not foundNullArgumentException
- stepProcessorEnablerId
or stepProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignStepProcessorEnablerFromStepProcessor(Id stepProcessorEnablerId, Id stepProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
StepProcessorEnabler
from a
StepProcessor.
stepProcessorEnablerId
- the Id
of the
StepProcessorEnabler
stepProcessorId
- the Id
of the
StepProcessor
NotFoundException
- stepProcessorEnablerId
or stepProcessorId
not found or
stepProcessorEnablerId
not applied to
stepProcessorId
NullArgumentException
- stepProcessorEnablerId
or stepProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceStepProcessorEnablers()
StepProcessorEnablers.
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 StepProcessorEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveStepProcessorEnablerAhead(Id stepProcessorEnablerId, Id stepProcessorId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
stepProcessorEnablerId
- the Id
of a
StepProcessorEnabler
stepProcessorId
- the Id
of a
StepProcessor
referenceId
- the reference step processor enabler Id
NotFoundException
- stepProcessorEnablerId,
stepProcessorId,
or referenceId
not
found or, stepProcessorEnablerId
or
referenceId
not related to stepProcessorId
NullArgumentException
- stepProcessorEnablerId,
stepProcessorId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveStepProcessorEnablerBehind(Id stepProcessorEnablerId, Id stepProcessorId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
stepProcessorEnablerId
- the Id
of a
StepProcessorEnabler
stepProcessorId
- the Id
of a
StepProcessor
referenceId
- the reference step processor enabler Id
NotFoundException
- stepProcessorEnablerId,
stepProcessorId,
or referenceId
not
found or, stepProcessorEnablerId
or
referenceId
not related to stepProcessorId
NullArgumentException
- stepProcessorEnablerId,
stepProcessorId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderStepProcessorEnablers(Id[] stepProcessorEnablerIds, Id stepProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
stepProcessorEnablerIds
- the Ids
for a set of
StepProcessorEnablers
stepProcessorId
- the Id
of a
StepProcessor
NotFoundException
- stepProcessorId
not
found or, an stepProcessorEnablerId
not related
to stepProcessorId
NullArgumentException
- stepProcessorEnablerIds
or stepProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.