public interface ValueEnablerConfigurationSession extends OsidSession
This session provides methods to retrieve ValueEnabler
to Configuration
mappings. A ValueEnabler
may appear in multiple Configuration
objects. Each
configuration may have its own authorizations governing who is allowed to
look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupValueEnablerConfigurationMappings()
Tests if this user can perform lookups of value enabler/configuration
mappings.
|
IdList |
getConfigurationIdsByValueEnabler(Id valueEnablerId)
Gets the
Configuration Ids mapped to a
ValueEnabler. |
ConfigurationList |
getConfigurationsByValueEnabler(Id valueEnablerId)
Gets the
Configurations mapped to a
ValueEnabler. |
IdList |
getValueEnablerIdsByConfiguration(Id configurationId)
Gets the list of
ValueEnablerIds associated with an
Configuration. |
IdList |
getValueEnablerIdsByConfigurations(IdList configurationIds)
Gets the list of
ValueEnabler Ids corresponding to a
list of Configurations. |
ValueEnablerList |
getValueEnablersByConfiguration(Id configurationId)
Gets the list of value enablers associated with an
Configuration. |
ValueEnablerList |
getValueEnablersByConfigurations(IdList configurationIds)
Gets the list of value enablers corresponding to a list of
Configurations. |
void |
useComparativeValueEnablerConfigurationView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
usePlenaryValueEnablerConfigurationView()
A complete view of the
ValueEnabler and
Configuration returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupValueEnablerConfigurationMappings()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeValueEnablerConfigurationView()
mandatory
- This method is must be implemented. void usePlenaryValueEnablerConfigurationView()
ValueEnabler
and
Configuration
returns is desired. Methods will return what is
requested or result in an error. This view is used when greater
precision is desired at the expense of interoperability.mandatory
- This method is must be implemented. IdList getValueEnablerIdsByConfiguration(Id configurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ValueEnablerIds
associated with an
Configuration.
configurationId
- Id
of the Configuration
Ids
NotFoundException
- configurationId
is
not foundNullArgumentException
- configurationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ValueEnablerList getValueEnablersByConfiguration(Id configurationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Configuration.
configurationId
- Id
of the Configuration
NotFoundException
- configurationId
is
not foundNullArgumentException
- configurationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getValueEnablerIdsByConfigurations(IdList configurationIds) throws OperationFailedException, PermissionDeniedException
ValueEnabler Ids
corresponding to a
list of Configurations.
configurationIds
- list of configuration Ids
Ids
NullArgumentException
- configurationIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ValueEnablerList getValueEnablersByConfigurations(IdList configurationIds) throws OperationFailedException, PermissionDeniedException
Configurations.
configurationIds
- list of configuration Ids
NullArgumentException
- configurationIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getConfigurationIdsByValueEnabler(Id valueEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Configuration
Ids
mapped to a
ValueEnabler.
valueEnablerId
- Id
of a ValueEnabler
NotFoundException
- valueEnablerId
is
not foundNullArgumentException
- valueEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ConfigurationList getConfigurationsByValueEnabler(Id valueEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Configurations
mapped to a
ValueEnabler.
valueEnablerId
- Id
of a ValueEnabler
NotFoundException
- valueEnablerId
is
not foundNullArgumentException
- valueEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.