public interface ParameterProcessorEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply
ParameterProcessorEnablers
to ParameterProcessors.
A ParameterProcessor
with multiple
ParameterProcessorEnablers
means any positive rule evaluation
across the enablers result in an effective ParameterProcessor.
Modifier and Type | Method and Description |
---|---|
void |
assignParameterProcessorEnablerToParameterProcessor(Id parameterProcessorEnablerId,
Id parameterProcessorId)
Adds an existing
ParameterProcessorEnabler to a
ParameterProcessor. |
boolean |
canAssignParameterProcessorEnablers()
Tests if this user can alter parameter processor enabler/parameter
processor mappings.
|
boolean |
canSequenceParameterProcessorEnablers()
Tests if this user can order
ParametereProcessorEnablers. |
Configuration |
getConfiguration()
Gets the
Configuration associated with this session. |
Id |
getConfigurationId()
Gets the
Configuration Id associated
with this session. |
void |
moveParameterProcessorEnablerAhead(Id parameterProcessorEnablerId,
Id parameterEnablerId,
Id referenceId)
Reorders parameter processor enablers for a parameter processor by
moving the specified parameter processor enabler in front of a
reference parameter enabler.
|
void |
moveParameterProcessorEnablerBehind(Id parameterProcessorEnablerId,
Id parameterEnablerId,
Id referenceId)
Reorders parameter processor enablers for a parameter by moving the
specified parameter processor enabler behind a reference parameter
processor enabler.
|
void |
orderParameterProcessorEnablers(Id[] parameterProcessorEnablerIds,
Id parameterProcessorId)
Reorders a set of parameter processor enablers for a parameter
processor.
|
void |
unassignParameterProcessorEnablerFromParameterProcessor(Id parameterProcessorEnablerId,
Id parameterProcessorId)
Removes a
ParameterProcessorEnabler from a
ParameterProcessor. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getConfigurationId()
Configuration
Id
associated
with this session. Configuration Id
associated with this
sessionmandatory
- This method must be implemented. Configuration getConfiguration() throws OperationFailedException, PermissionDeniedException
Configuration
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAssignParameterProcessorEnablers()
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 assignParameterProcessorEnablerToParameterProcessor(Id parameterProcessorEnablerId, Id parameterProcessorId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
ParameterProcessorEnabler
to a
ParameterProcessor.
parameterProcessorEnablerId
- the Id
of the
ParameterProcessorEnabler
parameterProcessorId
- the Id
of the
ParameterProcessor
AlreadyExistsException
-
parameterProcessorEnablerId
is already applied to
parameterProcessorId
NotFoundException
- parameterProcessorEnablerId
or parameterProcessorId
not foundNullArgumentException
-
parameterProcessorEnablerId
or
parameterProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignParameterProcessorEnablerFromParameterProcessor(Id parameterProcessorEnablerId, Id parameterProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ParameterProcessorEnabler
from a
ParameterProcessor.
parameterProcessorEnablerId
- the Id
of the
ParameterProcessorEnabler
parameterProcessorId
- the Id
of the
ParameterProcessor
NotFoundException
- parameterProcessorEnablerId
or parameterProcessorId
not found or
parameterProcessorEnablerId
is not applied to
parameterProcessorId
NullArgumentException
-
parameterProcessorEnablerId
or
parameterProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceParameterProcessorEnablers()
ParametereProcessorEnablers.
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 ParameterProcessorEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveParameterProcessorEnablerAhead(Id parameterProcessorEnablerId, Id parameterEnablerId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
parameterProcessorEnablerId
- the Id
of a
ParameterProcessorEnabler
parameterEnablerId
- the Id
of a
ParameterProcessor
referenceId
- the reference parameter processor enabler
Id
NotFoundException
- parameterProcessorEnablerId,
parameterEnablerId,
or referenceId
not
found or, parameterProcessorEnablerId,
or
referenceId
not related to
parameterEnablerId
NullArgumentException
-
parameterProcessorEnablerId, parameterEnablerId,
or
referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveParameterProcessorEnablerBehind(Id parameterProcessorEnablerId, Id parameterEnablerId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
parameterProcessorEnablerId
- the Id
of a
ParameterProcessorEnabler
parameterEnablerId
- the Id
of a
ParameterProcessor
referenceId
- the reference parameter processor enabler
Id
NotFoundException
- parameterProcessorEnablerId,
parameterEnablerId,
or referenceId
not
found or, parameterProcessorEnablerId,
or
referenceId
not related to
parameterEnablerId
NullArgumentException
-
parameterProcessorEnablerId, parameterEnablerId,
or
referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderParameterProcessorEnablers(Id[] parameterProcessorEnablerIds, Id parameterProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
parameterProcessorEnablerIds
- the Ids
for a set
of ParameterProcessorEnablers
parameterProcessorId
- the Id
of a
ParameterProcessor
NotFoundException
- parameterProcessorId
not found or, a parameterProcessorEnablerId
not
related to parameterProcessorId
NullArgumentException
-
parameterProcessorEnablerIds
or
parameterProcessorId,
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.