public interface ParameterProcessorConfigurationAssignmentSession extends OsidSession
This session provides methods to re-assign ParameterProcessor
to Configuration
mappings. A
ParameterProcessor
may appear in multiple Configuration
objects and removing the last reference to a
ParameterProcessor
is the equivalent of deleting it. Each
Configuration
may have its own authorizations governing who is
allowed to operate on it.
Adding a reference of a ParameterProcessor
to another
Configuration
is not a copy operation (eg: does not change
its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignParameterProcessorToConfiguration(Id parameterProcessorId,
Id configurationId)
Adds an existing
ParameterProcessor to an
Configuration. |
boolean |
canAssignParameterProcessors()
Tests if this user can alter parameter processor/configuration
mappings.
|
boolean |
canAssignParameterProcessorsToConfiguration(Id configurationId)
Tests if this user can alter parameter processor/configuration
mappings.
|
IdList |
getAssignableConfigurationIds(Id configurationId)
Gets a list of configurations including and under the given
configuration node in which any parameter processor can be assigned.
|
IdList |
getAssignableConfigurationIdsForParameterProcessor(Id configurationId,
Id parameterProcessorId)
Gets a list of configurations including and under the given
configuration node in which a specific parameter processor can be
assigned.
|
void |
reassignParameterProcessorToConfiguration(Id parameterProcessorId,
Id fromConfigurationId,
Id toConfigurationId)
Moves a
ParameterProcessor from one
Configuration to another. |
void |
unassignParameterProcessorFromConfiguration(Id parameterProcessorId,
Id configurationId)
Removes a
ParameterProcessor from a
Configuration. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignParameterProcessors()
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. boolean canAssignParameterProcessorsToConfiguration(Id configurationId)
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users.configurationId
- the Id
of the
Configuration
false
if mapping is not authorized, true
otherwiseNullArgumentException
- configurationId
is null
mandatory
- This method must be implemented. IdList getAssignableConfigurationIds(Id configurationId) throws OperationFailedException
configurationId
- the Id
of the
Configuration
Ids
NullArgumentException
- configurationId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableConfigurationIdsForParameterProcessor(Id configurationId, Id parameterProcessorId) throws OperationFailedException
configurationId
- the Id
of the
Configuration
parameterProcessorId
- the Id
of the
ParameterProcessor
Ids
NullArgumentException
- configurationId
or parameterProcessorId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignParameterProcessorToConfiguration(Id parameterProcessorId, Id configurationId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
ParameterProcessor
to an
Configuration.
parameterProcessorId
- the Id
of the
ParameterProcessor
configurationId
- the Id
of the
Configuration
AlreadyExistsException
- parameterProcessorId
is already assigned to configurationId
NotFoundException
- parameterProcessorId
or configurationId
not foundNullArgumentException
- parameterProcessorId
or configurationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignParameterProcessorFromConfiguration(Id parameterProcessorId, Id configurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ParameterProcessor
from a
Configuration.
parameterProcessorId
- the Id
of the
ParameterProcessor
configurationId
- the Id
of the
Configuration
NotFoundException
- parameterProcessorId
or configurationId
not found or
parameterProcessorId
is not assigned to
configurationId
NullArgumentException
- parameterProcessorId
or configurationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignParameterProcessorToConfiguration(Id parameterProcessorId, Id fromConfigurationId, Id toConfigurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ParameterProcessor
from one
Configuration
to another. Mappings to other
Configurations
are unaffected.parameterProcessorId
- the Id
of the
ParameterProcessor
fromConfigurationId
- the Id
of the current
Configuration
toConfigurationId
- the Id
of the destination
Configuration
NotFoundException
- parameterProcessorId
fromConfigurationId,
or toConfigurationId
not found or parameterProcessorId
not
mapped to fromConfigurationId
NullArgumentException
- parameterProcessorId,
fromConfigurationId,
or toConfigurationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.