public interface ValueEnablerConfigurationAssignmentSession extends OsidSession
This session provides methods to re-assign ValueEnabler
to Configuration
mappings. A ValueEnabler
may appear in multiple Configuration
objects and removing
the last reference to a ValueEnabler
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 ValueEnabler
to another
Configuration
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignValueEnablerToConfiguration(Id valueEnablerId,
Id configurationId)
Adds an existing
ValueEnabler to a
Configuration. |
boolean |
canAssignValueEnablers()
Tests if this user can alter value enabler/configuration mappings.
|
boolean |
canAssignValueEnablersToConfiguration(Id configurationId)
Tests if this user can alter value enabler/configuration mappings.
|
IdList |
getAssignableConfigurationIds(Id configurationId)
Gets a list of configurations including and under the given
configuration node in which any value enabler can be assigned.
|
IdList |
getAssignableConfigurationIdsForValueEnabler(Id configurationId,
Id valueEnablerId)
Gets a list of configurations including and under the given
configuration node in which a specific value enabler can be assigned.
|
void |
reassignValueEnablerToConfiguration(Id valueEnablerId,
Id fromConfigurationId,
Id toConfigurationId)
Moves a
ValueEnabler from one Configuration
to another. |
void |
unassignValueEnablerFromConfiguration(Id valueEnablerId,
Id configurationId)
Removes a
ValueEnabler from a Configuration. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignValueEnablers()
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 canAssignValueEnablersToConfiguration(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 getAssignableConfigurationIdsForValueEnabler(Id configurationId, Id valueEnablerId) throws OperationFailedException
configurationId
- the Id
of the
Configuration
valueEnablerId
- the Id
of the
ValueEnabler
Ids
NullArgumentException
- configurationId
or valueEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignValueEnablerToConfiguration(Id valueEnablerId, Id configurationId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
ValueEnabler
to a
Configuration.
valueEnablerId
- the Id
of the
ValueEnabler
configurationId
- the Id
of the
Configuration
AlreadyExistsException
- valueEnablerId
is already assigned to configurationId
NotFoundException
- valueEnablerId
or
configurationId
not foundNullArgumentException
- valueEnablerId
or configurationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignValueEnablerFromConfiguration(Id valueEnablerId, Id configurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ValueEnabler
from a Configuration.
valueEnablerId
- the Id
of the
ValueEnabler
configurationId
- the Id
of the
Configuration
NotFoundException
- valueEnablerId
or
configurationId
not found or
valueEnablerId
is not assigned to
configurationId
NullArgumentException
- valueEnablerId
or configurationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignValueEnablerToConfiguration(Id valueEnablerId, Id fromConfigurationId, Id toConfigurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ValueEnabler
from one Configuration
to another. Mappings to other Configurations
are unaffected.valueEnablerId
- the Id
of the
ValueEnabler
fromConfigurationId
- the Id
of the current
Configuration
toConfigurationId
- the Id
of the destination
Configuration
NotFoundException
- valueEnablerId,
fromConfigurationId,
or toConfigurationId
not found or valueEnablerId
not mapped
to fromConfigurationId
NullArgumentException
- valueEnablerId,
cromConfigurationId,
or toConfigurationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.