Interface ValueRetrievalSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

ValueLookupSession

public interface ValueRetrievalSession
extends OsidSession

This session is used to retrieve active and applicable configuration values through evaluation of active and pertinent values based on the context or conditional input.

Method Summary

Modifier and Type	Method	Description
boolean	canRetrieveValues()	Tests if this user can perform Value retrievals.
Value	getApplicableValueByParameter(Id parameterId)	Gets an applicable Value for the given parameter Id .
Value	getApplicableValueByParameterOnCondition(Id parameterId, ValueCondition valueCondition)	Gets an applicable value in this configuration based on a condition.
ValueList	getApplicableValuesByParameter(Id parameterId)	Gets all the applicable Values for the given parameter Id .
ValueList	getApplicableValuesByParameterOnCondition(Id parameterId, ValueCondition valueCondition)	Gets all the applicable values for a parameter based on a condition.
ValueList	getApplicableValuesByParameters(IdList parameterIds)	Gets the applicable Values for the given parameter Ids .
ValueList	getApplicableValuesByParametersOnCondition(IdList parameterIds, ValueCondition valueCondition)	Gets the applicable values for parameters based on a condition.
Configuration	getConfiguration()	Gets the Configuration associated with this session.
Id	getConfigurationId()	Gets the Configuration Id associated with this session.
ValueCondition	getValueCondition(Id parameterId)	Gets a value condition for the given parameter.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getConfigurationId

Id getConfigurationId()

Gets the Configuration Id associated with this session.

Returns:

the Configuration Id associated with this session

Compliance:

mandatory - This method must be implemented.

getConfiguration

Configuration getConfiguration()
                        throws OperationFailedException,
PermissionDeniedException

Gets the Configuration associated with this session.

Returns:

the Configuration associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRetrieveValues

boolean canRetrieveValues()

Tests if this user can perform Value retrievals. 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.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getApplicableValueByParameter

Value getApplicableValueByParameter(Id parameterId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets an applicable 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.

Parameters:

parameterId - the Id of the Parameter to retrieve

Returns:

the value

Throws:

NotFoundException - the parameterId not found or no value available

NullArgumentException - the parameterId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getApplicableValuesByParameter

ValueList getApplicableValuesByParameter(Id parameterId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets all the applicable Values for the given parameter Id .

Parameters:

parameterId - the Id of the Parameter to retrieve

Returns:

the value list

Throws:

NotFoundException - the parameterId not found

NullArgumentException - the parameterId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getApplicableValuesByParameters

ValueList getApplicableValuesByParameters(IdList parameterIds)
                                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the applicable Values for the given parameter Ids .

Parameters:

parameterIds - the Id of the Parameter to retrieve

Returns:

the value list

Throws:

NotFoundException - a parameter Id is not found

NullArgumentException - parameterIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getValueCondition

ValueCondition getValueCondition(Id parameterId)

Gets a value condition for the given parameter.

Parameters:

parameterId - the Id of a Parameter

Returns:

a value condition

Throws:

NullArgumentException - parameterId is null

Compliance:

mandatory - This method must be implemented.

getApplicableValueByParameterOnCondition

Value getApplicableValueByParameterOnCondition(Id parameterId,
 ValueCondition valueCondition)
                                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets an applicable value in this configuration based on a condition. If multiple values are available the most preferred one is returned. The condition specified is applied to any or all parameters in this configuration as applicable.

Parameters:

parameterId - the Id of a Parameter

valueCondition - the condition

Returns:

the value

Throws:

NotFoundException - parameter Id is not found

NullArgumentException - parameterId or valueCondition is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - valueCondition did not originate from getValueCondition()

Compliance:

mandatory - This method must be implemented.

getApplicableValuesByParameterOnCondition

ValueList getApplicableValuesByParameterOnCondition(Id parameterId,
 ValueCondition valueCondition)
                                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets all the applicable values for a parameter based on a condition.

Parameters:

parameterId - the Id of a Parameter

valueCondition - the condition

Returns:

the value list

Throws:

NotFoundException - parameter Id is not found

NullArgumentException - parameterId or valueCondition is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - valueCondition did not originate from getValueCondition()

Compliance:

mandatory - This method must be implemented.

getApplicableValuesByParametersOnCondition

ValueList getApplicableValuesByParametersOnCondition(IdList parameterIds,
 ValueCondition valueCondition)
                                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the applicable values for parameters based on a condition. The specified condition is applied to any or all of the parameters as applicable.

Parameters:

parameterIds - the Id of a Parameter

valueCondition - the condition

Returns:

the value list

Throws:

NotFoundException - a parameter Id is not found

NullArgumentException - parameterIds or valueCondition is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - valueCondition did not originate from getValueCondition()

Compliance:

mandatory - This method must be implemented.