Interface ParameterQuerySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

ParameterSearchSession

public interface ParameterQuerySession
extends OsidSession

This session provides methods for searching Parameters . The search query is constructed using the ParameterQuery .

Two views of the configuration data are defined;

• federated: parameters defined in configurations that are a parent of this configuration in the configuration hierarchy are included
• isolated: parameters are contained to within this configuration

Method Summary

Modifier and Type	Method	Description
boolean	canSearchParameters()	Tests if this user can perform Parameter searches.
Configuration	getConfiguration()	Gets the Configuration associated with this session.
Id	getConfigurationId()	Gets the Configuration Id associated with this session.
ParameterQuery	getParameterQuery()	Gets a paraameter query.
ParameterList	getParametersByQuery(ParameterQuery parameterQuery)	Gets a list of Parameters matching the given query.
void	useFederatedConfigurationView()	Federates the view for methods in this session.
void	useIsolatedConfigurationView()	Isolates the view for methods in this session.

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.

canSearchParameters

boolean canSearchParameters()

Tests if this user can perform Parameter searches. 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 search operations to unauthorized users.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedConfigurationView

void useFederatedConfigurationView()

Federates the view for methods in this session. A federated view will include parameters from parent configurations in the configuration hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedConfigurationView

void useIsolatedConfigurationView()

Isolates the view for methods in this session. An isolated view restricts searches to this configuration only.

Compliance:

mandatory - This method is must be implemented.

getParameterQuery

ParameterQuery getParameterQuery()

Gets a paraameter query.

Returns:

the parameter query

Compliance:

mandatory - This method must be implemented.

getParametersByQuery

ParameterList getParametersByQuery(ParameterQuery parameterQuery)
                            throws OperationFailedException,
PermissionDeniedException

Gets a list of Parameters matching the given query.

Parameters:

parameterQuery - the parameter query

Returns:

the returned ParameterList

Throws:

NullArgumentException - parameterQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - a query form is not of this service

Compliance:

mandatory - This method must be implemented.