public interface ValueEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve ValueEnabler
to Value
mappings. A Value
with multiple
ValueEnablers
means any positive rule evaluation across the
enablers result in a visible Value.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupValueEnablerRules()
Tests if this user can perform lookups of value enabler/value
mappings.
|
Configuration |
getConfiguration()
Gets the
Configuration associated with this session. |
Id |
getConfigurationId()
Gets the
Configuration Id associated
with this session. |
IdList |
getValueEnablerIdsForValue(Id valueId)
Gets the
ValueEnabler Id associated with a
Value. |
ValueEnablerList |
getValueEnablersForValue(Id valueId)
Gets the
ValueEnablers associated with a Value. |
IdList |
getValueIdsForValueEnabler(Id valueEnablerId)
Gets the
Value Ids mapped to a
ValueEnabler. |
ValueList |
getValuesForValueEnabler(Id valueEnablerId)
Gets the
Values mapped to a ValueEnabler. |
void |
useComparativeValueEnablerRuleView()
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 |
useFederatedConfigurationView()
Federates the view for methods in this session.
|
void |
useIsolatedConfigurationView()
Isolates the view for methods in this session.
|
void |
usePlenaryValueEnablerRuleView()
A complete view of the
ValueEnabler and Value
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getConfigurationId()
Configuration
Id
associated
with this session. Configuration Id
associated with this
sessionmandatory
- This method must be implemented. Configuration getConfiguration() throws OperationFailedException, PermissionDeniedException
Configuration
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupValueEnablerRules()
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 useComparativeValueEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryValueEnablerRuleView()
ValueEnabler
and Value
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. void useFederatedConfigurationView()
mandatory
- This method is must be implemented. void useIsolatedConfigurationView()
mandatory
- This method is must be implemented. IdList getValueEnablerIdsForValue(Id valueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ValueEnabler Id
associated with a
Value.
valueId
- Id
of the Value
Ids
NotFoundException
- valueId
is not foundNullArgumentException
- valueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ValueEnablerList getValueEnablersForValue(Id valueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ValueEnablers
associated with a Value.
valueId
- Id
of the Value
NotFoundException
- valueId
is not foundNullArgumentException
- valueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getValueIdsForValueEnabler(Id valueEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Value
Ids
mapped to a
ValueEnabler.
valueEnablerId
- Id
of a ValueEnabler
Ids
NotFoundException
- valueEnablerId
is
not foundNullArgumentException
- valueEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ValueList getValuesForValueEnabler(Id valueEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Values
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.