public interface ParameterConfigurationAssignmentSession extends OsidSession
This session provides methods to re-assign Parameters
to
Configurations.
A Parameter
may appear in
multiple Configurations
and removing the last reference to
a Parameter
is the equivalent of deleting it which may or
may not be permitted. Each Configuration
may have its own
authorizations as to who is allowed to operate on it.
Moving or adding a reference of a Parameter
to another
Configuration
is not a copy operation (eg: does not change
its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignParameterToConfiguration(Id parameterId,
Id configurationId)
Adds an existing
Parameter to a Configuration. |
boolean |
canAssignParameterConfigurations()
Tests if this user can change parameter configuration mappings.
|
boolean |
canAssignParametersToConfiguration(Id configurationId)
Tests if this user can alter parameter/configuration parameters.
|
IdList |
getAssignableConfigurationIds(Id configurationId)
Gets a list of configurations including and under the given
configuration node in which any parameter can be assigned.
|
IdList |
getAssignableConfigurationIdsForParameter(Id configurationId,
Id parameterId)
Gets a list of configurations including and under the given
configuration node in which a specific parameter can be assigned.
|
void |
reassignParameterToConfiguration(Id parameterId,
Id fromConfigurationId,
Id toConfigurationId)
Moves a
Parameter from one Configuration
to another. |
void |
unassignParameterFromConfiguration(Id parameterId,
Id configurationId)
Removes a
Parameter from a Configuration. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignParameterConfigurations()
PERMISSION_DENIED.
This is intended as a
hint to an application that may not wish to offer assignment
operations. false
if parameter configuration assignment is
not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignParametersToConfiguration(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 configuration 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 getAssignableConfigurationIdsForParameter(Id configurationId, Id parameterId) throws OperationFailedException
configurationId
- the Id
of the
Configuration
parameterId
- the Id
of the Parameter
Ids
NullArgumentException
- configurationId
or parameterId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignParameterToConfiguration(Id parameterId, Id configurationId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Parameter
to a Configuration.
parameterId
- the Id
of the Parameter
configurationId
- the Id
of the
Configuration
AlreadyExistsException
- parameterId
and
configurationId
already mappedNotFoundException
- parameterId
or
configurationId
not foundNullArgumentException
- parameterId
or
configurationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignParameterFromConfiguration(Id parameterId, Id configurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Parameter
from a Configuration.
parameterId
- the Id of the Parameter
configurationId
- the Id of the Configuration
NotFoundException
- parameterId
or
configurationId
not found or is not mappedNullArgumentException
- parameterId
or
configurationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignParameterToConfiguration(Id parameterId, Id fromConfigurationId, Id toConfigurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Parameter
from one Configuration
to another. Mappings to other Configurations
are
unaffected.parameterId
- the Id
of the Parameter
fromConfigurationId
- the Id
of the current
Configuration
toConfigurationId
- the Id
of the destination
Configuration
NotFoundException
- parameterId
fromConfigurationId,
or toConfigurationId
not found or creditId
not mapped to
fromConfigurationId
NullArgumentException
- parameterId,
fromConfigurationId,
or toConfigurationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.