public interface ValueRetrievalSession extends OsidSession
This session is used to retrieve active configuration values. Two views of the configuration data are defined:
This session assumes an active view.
Values are not OSID objects and are obtained using a reference to a Parameter.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupValues()
Tests if this user can perform
Value lookups. |
Configuration |
getConfiguration()
Gets the
Configuration associated with this session. |
Id |
getConfigurationId()
Gets the
Configuration Id associated
with this session. |
Value |
getValueByParameter(Id parameterId)
Gets a
Value for the given parameter Id. |
Value |
getValueByParameterOnCondition(Id parameterId,
ValueCondition valueCondition)
Gets a value in this configuration based on a condition.
|
ValueCondition |
getValueCondition(Id parameterId)
Gets a value condition for the given parameter.
|
ValueList |
getValuesByParameter(Id parameterId)
Gets all the
Values for the given parameter Id. |
ValueList |
getValuesByParameterOnCondition(Id parameterId,
ValueCondition valueCondition)
Gets all the values for a parameter based on a condition.
|
ValueList |
getValuesByParameters(IdList parameterIds)
Gets the
Values for the given parameter Ids. |
ValueList |
getValuesByParametersOnCondition(IdList parameterIds,
ValueCondition valueCondition)
Gets the values for parameters based on a condition.
|
void |
useComparativeValueView()
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 |
useConditionalView()
Returns only values that pass the defined parameter condition.
|
void |
useFederatedConfigurationView()
Federates the view for methods in this session.
|
void |
useIsolatedConfigurationView()
Isolates the view for methods in this session.
|
void |
usePlenaryValueView()
A complete view of the
Value returns is desired. |
void |
useUnconditionalView()
Values that are filtered based on an implicit condition are not
filtered out from methods in this session.
|
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. Configuration
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupValues()
Value
lookups. A return
of true does not guarantee successful authorization. A return of false
indicates that it is known all methods in this session will result in
a PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeValueView()
mandatory
- This method is must be implemented. void usePlenaryValueView()
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. void useConditionalView()
Values
returned from any method in this
session are filtered on an implicit condition.mandatory
- This method is must be implemented. void useUnconditionalView()
mandatory
- This method is must be implemented. Value getValueByParameter(Id parameterId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Value
for the given parameter Id.
If more than one value exists for the given parameter, the most
preferred value is returned. This method can be used as a convenience
when only one value is expected. getValuesByParameters()
should be used for getting all the active values.parameterId
- the Id
of the Parameter
to retrieveNotFoundException
- the parameterId
not
found or no value availableNullArgumentException
- the parameterId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ValueList getValuesByParameter(Id parameterId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Values
for the given parameter Id.
In plenary mode, all values are returned in the order requested or an
error results. In comparative mode, inaccessible values may be omitted
or the values reordered.
In conditional mode, the values are filtered through evaluation. In
unconditional mode, the values are returned unfiltered.parameterId
- the Id
of the Parameter
to retrieveNotFoundException
- the parameterId
not
foundNullArgumentException
- the parameterId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ValueList getValuesByParameters(IdList parameterIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
Values
for the given parameter Ids.
In plenary mode, the values for all parameters are returned in the
order requested or an error results. In comparative mode, inaccessible
values may be omitted or the values reordered.
In conditional mode, the values are filtered through evaluation. In
unconditional mode, the values are returned unfiltered.parameterIds
- the Id
of the Parameter
to retrieveNotFoundException
- a parameter Id
is
not foundNullArgumentException
- parameterIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ValueCondition getValueCondition(Id parameterId)
parameterId
- the Id
of a Parameter
NullArgumentException
- parameterId
is
null
mandatory
- This method must be implemented. Value getValueByParameterOnCondition(Id parameterId, ValueCondition valueCondition) throws NotFoundException, OperationFailedException, PermissionDeniedException
parameterId
- the Id
of a Parameter
valueCondition
- the conditionNotFoundException
- parameter Id
is not
foundNullArgumentException
- parameterId
or
valueCondition
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- valueCondition
not of this servicemandatory
- This method must be implemented. ValueList getValuesByParameterOnCondition(Id parameterId, ValueCondition valueCondition) throws NotFoundException, OperationFailedException, PermissionDeniedException
parameterId
- the Id
of a Parameter
valueCondition
- the conditionNotFoundException
- parameter Id
is not
foundNullArgumentException
- parameterId
or
valueCondition
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- valueCondition
is
not of this servicemandatory
- This method must be implemented. ValueList getValuesByParametersOnCondition(IdList parameterIds, ValueCondition valueCondition) throws NotFoundException, OperationFailedException, PermissionDeniedException
parameterIds
- the Id
of a Parameter
valueCondition
- the conditionNotFoundException
- a parameter Id
is
not foundNullArgumentException
- parameterIds
or
valueCondition
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- valueCondition
not of this servicemandatory
- This method must be implemented.