OSID Logo
OSID Specifications
configuration package
Version 3.1.0
Interfaceosid.configuration.ConfigurationQuerySession
Implementsosid.OsidSession
Implemented Byosid.configuration.ConfigurationSearchSession
Used Byosid.configuration.ConfigurationManager
osid.configuration.ConfigurationProxyManager
Description

This session provides methods for searching among Configurations. 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.

MethodcanSearchConfigurations
Description

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.

Returnboolean false if search methods are not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodgetConfigurationQuery
Description

Gets a configuration query.

Returnosid.configuration.ConfigurationQuery the configuration query
Compliancemandatory This method must be implemented.
MethodgetConfigurationsByQuery
Description

Gets a list of Configurations matching the given search.

Parametersosid.configuration.ConfigurationQueryconfigurationQuery the configuration query
Returnosid.configuration.ConfigurationList the returned ConfigurationList
ErrorsNULL_ARGUMENT configurationQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED configurationQuery is not of this service
Compliancemandatory This method must be implemented.