org.osid.configuration

Interface ConfigurationQuerySession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

All Known Subinterfaces:

ConfigurationSearchSession

public interface ConfigurationQuerySession
extends OsidSession

This session provides methods for searching among Configuration objects. The search query is constructed using the ConfigurationQuery.

Configurations may have a query record indicated by their respective record types. The query record is accessed via the ConfigurationQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchConfigurations() Tests if this user can perform Configuration searches.
ConfigurationQuery	getConfigurationQuery() Gets a configuration query.
ConfigurationList	getConfigurationsByQuery(ConfigurationQuery configurationQuery) Gets a list of Configurations matching the given search.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canSearchConfigurations

boolean canSearchConfigurations()

Tests if this user can perform Configuration 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 search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getConfigurationQuery

ConfigurationQuery getConfigurationQuery()

Gets a configuration query.

Returns:

the configuration query

Compliance:

mandatory - This method must be implemented.

getConfigurationsByQuery

ConfigurationList getConfigurationsByQuery(ConfigurationQuery configurationQuery)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Gets a list of Configurations matching the given search.

Parameters:

configurationQuery - the configuration query

Returns:

the returned ConfigurationList

Throws:

NullArgumentException - configurationQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - configurationQuery is not of this service

Compliance:

mandatory - This method must be implemented.