public interface ValueLookupSession extends ValueRetrievalSession
This session is used to retrieve configuration values. Two views of the configuration data are defined:
Values are not OSID objects and are obtained using a reference to a Parameter.
Modifier and Type | Method and Description |
---|---|
Value |
getValue(Id valueId)
Gets the
Value specified by its Id. |
ValueList |
getValues()
Gets all the values in this configuration.
|
ValueList |
getValuesByGenusType(Type valueGenusType)
Gets a
ValueList corresponding to the given value genus
Type which does not include values of genus types
derived from the specified Type. |
ValueList |
getValuesByIds(IdList valueIds)
Gets a
ValueList corresponding to the given
IdList. |
ValueList |
getValuesByParentGenusType(Type valueGenusType)
Gets a
ValueList corresponding to the given value genus
Type and include any additional values with genus types
derived from the specified Type. |
ValueList |
getValuesByRecordType(Type valueRecordType)
Gets a
ValueList corresponding to the given value
record Type which does not include values of record
types derived from the specified Type. |
ValueList |
getValuesOnCondition(ValueCondition valueCondition)
Gets the values in this configuration based on a condition.
|
void |
useActiveValueView()
Only active values are returned by methods in this session.
|
void |
useAnyStatusValueView()
All active and inactive values are returned by methods in this
session.
|
canLookupValues, getConfiguration, getConfigurationId, getValueByParameter, getValueByParameterOnCondition, getValueCondition, getValuesByParameter, getValuesByParameterOnCondition, getValuesByParameters, getValuesByParametersOnCondition, useComparativeValueView, useConditionalView, useFederatedConfigurationView, useIsolatedConfigurationView, usePlenaryValueView, useUnconditionalView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
void useActiveValueView()
mandatory
- This method is must be implemented. void useAnyStatusValueView()
mandatory
- This method is must be implemented. Value getValue(Id valueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Value
specified by its Id.
In
plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Value
may have a different Id
than requested, such as
the case where a duplicate Id
was assigned to a
Value
and retained for compatibility.valueId
- the Id
of the Value
to
retrieve Value
NotFoundException
- no Value
found with
the given Id
NullArgumentException
- valueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ValueList getValuesByIds(IdList valueIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ValueList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
values specified in the Id
list, in the order of the
list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Values
may be omitted from the list and
may present the elements in any order including returning a unique
set.valueIds
- the list of Ids
to retrieve Value
listNotFoundException
- an Id was
not foundNullArgumentException
- valueIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ValueList getValuesByGenusType(Type valueGenusType) throws OperationFailedException, PermissionDeniedException
ValueList
corresponding to the given value genus
Type
which does not include values of genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
values or an error results. Otherwise, the returned list may contain
only those values that are accessible through this session.
In active mode, values are returned that are currently active. In any
status mode, active and inactive values are returned.valueGenusType
- a value genus type Value list
NullArgumentException
- valueGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ValueList getValuesByParentGenusType(Type valueGenusType) throws OperationFailedException, PermissionDeniedException
ValueList
corresponding to the given value genus
Type
and include any additional values with genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
values or an error results. Otherwise, the returned list may contain
only those values that are accessible through this session.
In active mode, values are returned that are currently active. In any
status mode, active and inactive values are returned.valueGenusType
- a value genus type Value list
NullArgumentException
- valueGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ValueList getValuesByRecordType(Type valueRecordType) throws OperationFailedException, PermissionDeniedException
ValueList
corresponding to the given value
record Type
which does not include values of record
types derived from the specified Type.
In plenary mode, the returned list contains all known
values or an error results. Otherwise, the returned list may contain
only those values that are accessible through this session.
In active mode, values are returned that are currently active. In any
status mode, active and inactive values are returned.valueRecordType
- a value type Value
listNullArgumentException
- valueRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ValueList getValues() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ValueList getValuesOnCondition(ValueCondition valueCondition) throws OperationFailedException, PermissionDeniedException
The condition specified is applied to any or all parameters in
this configuration as applicable. In plenary mode, all values are
returned or an error results. In comparative mode, inaccessible values
may be omitted.valueCondition
- a value conditionNullArgumentException
- valueCondition
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- valueCondition
not of this servicemandatory
- This method must be implemented.