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

This session provides methods for searching Parameter objects. 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
MethodgetConfigurationId
Description

Gets the Configuration Id associated with this session.

Returnosid.id.Idthe Configuration Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetConfiguration
Description

Gets the Configuration associated with this session.

Returnosid.configuration.Configurationthe Configuration associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchParameters
Description

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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedConfigurationView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedConfigurationView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetParameterQuery
Description

Gets a paraameter query.

Returnosid.configuration.ParameterQuerythe parameter query
CompliancemandatoryThis method must be implemented.
MethodgetParametersByQuery
Description

Gets a list of Parameters matching the given query.

Parametersosid.configuration.ParameterQueryparameterQuerythe parameter query
Returnosid.configuration.ParameterListthe returned ParameterList
ErrorsNULL_ARGUMENT parameterQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDa query form is not of this service
CompliancemandatoryThis method must be implemented.