public interface ParameterProcessorEnablerConfigurationAssignmentSession extends OsidSession
This session provides methods to re-assign
ParameterProcessorEnabler
to Configuration
mappings. A ParameterProcessorEnabler
may appear in
multiple Configuration
objects and removing the last
reference to a ParameterProcessorEnabler
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 ParameterProcessorEnabler
to
another Configuration
is not a copy operation (eg: does not
change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignParameterProcessorEnablerToConfiguration(Id parameterProcessorEnablerId,
Id configurationId)
Adds an existing
ParameterProcessorEnabler to an
Configuration. |
boolean |
canAssignParameterProcessorEnablers()
Tests if this user can alter parameter processor enabler/configuration
mappings.
|
boolean |
canAssignParameterProcessorEnablersToConfiguration(Id configurationId)
Tests if this user can alter parameter processor enabler/configuration
mappings.
|
IdList |
getAssignableConfigurationIds(Id configurationId)
Gets a list of configurations including and under the given
configuration node in which any parameter processor enabler can be
assigned.
|
IdList |
getAssignableConfigurationIdsForParameterProcessorEnabler(Id configurationId,
Id parameterProcessorEnablerId)
Gets a list of configurations including and under the given
configuration node in which a specific parameter processor enabler can
be assigned.
|
void |
unassignParameterProcessorEnablerFromConfiguration(Id parameterProcessorEnablerId,
Id configurationId)
Removes a
ParameterProcessorEnabler from an
Configuration. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
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. boolean canAssignParameterProcessorEnablersToConfiguration(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 getAssignableConfigurationIdsForParameterProcessorEnabler(Id configurationId, Id parameterProcessorEnablerId) throws OperationFailedException
configurationId
- the Id
of the
Configuration
parameterProcessorEnablerId
- the Id
of the
ParameterProcessorEnabler
Ids
NullArgumentException
- configurationId
or parameterProcessorEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignParameterProcessorEnablerToConfiguration(Id parameterProcessorEnablerId, Id configurationId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
ParameterProcessorEnabler
to an
Configuration.
parameterProcessorEnablerId
- the Id
of the
ParameterProcessorEnabler
configurationId
- the Id
of the
Configuration
AlreadyExistsException
-
parameterProcessorEnablerId
is already assigned to
configurationId
NotFoundException
- parameterProcessorEnablerId
or configurationId
not foundNullArgumentException
-
parameterProcessorEnablerId
or configurationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignParameterProcessorEnablerFromConfiguration(Id parameterProcessorEnablerId, Id configurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ParameterProcessorEnabler
from an
Configuration.
parameterProcessorEnablerId
- the Id
of the
ParameterProcessorEnabler
configurationId
- the Id
of the
Configuration
NotFoundException
- parameterProcessorEnablerId
or configurationId
or
parameterProcessorEnablerId
is not assigned to
configurationId
NullArgumentException
-
parameterProcessorEnablerId
or configurationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.