OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.SystemQuerySession
Implementsosid.OsidSession
Description

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

Systems may have a query record indicated by their respective record types. The query record is accessed via the SystemQuery.

MethodcanSearchSystems
Description

Tests if this user can perform System 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 not offer lookup operations to unauthorized users.

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

Gets a system query.

Returnosid.control.SystemQuerythe system query
CompliancemandatoryThis method must be implemented.
MethodgetSystemsByQuery
Description

Gets a list of Systems matching the given system query.

Parametersosid.control.SystemQuerysystemQuerythe system query
Returnosid.control.SystemListthe returned SystemList
ErrorsNULL_ARGUMENT systemQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED systemQuery is not of this service
CompliancemandatoryThis method must be implemented.