OSID Logo
OSID Specifications
configuration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.ConfigurationQuerySession
Implementsosid.OsidSession
Description

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.

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
CompliancemandatoryThis method must be implemented.
MethodgetConfigurationQuery
Description

Gets a configuration query.

Returnosid.configuration.ConfigurationQuerythe configuration query
CompliancemandatoryThis method must be implemented.
MethodgetConfigurationsByQuery
Description

Gets a list of Configurations matching the given search.

Parametersosid.configuration.ConfigurationQueryconfigurationQuerythe configuration query
Returnosid.configuration.ConfigurationListthe returned ConfigurationList
ErrorsNULL_ARGUMENT configurationQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED configurationQuery is not of this service
CompliancemandatoryThis method must be implemented.