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

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

This session defines views that offer differing behaviors for searching.

  • federated trigger view: searches include controllers in triggers of which this trigger is an ancestor in the trigger hierarchy
  • isolated trigger view: searches are restricted to controllers in this trigger

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

MethodgetSystemId
Description

Gets the System Id associated with this session.

Returnosid.id.Idthe System Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetSystem
Description

Gets the System associated with this session.

Returnosid.control.Systemthe system
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchControllers
Description

Tests if this user can perform Controller lookups. 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.
MethoduseFederatedSystemView
Description

Federates the view for methods in this session. A federated view will include controllers in systems which are children of this trigger in the system hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedSystemView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this system only.

CompliancemandatoryThis method is must be implemented.
MethodgetControllerQuery
Description

Gets a controller query.

Returnosid.control.ControllerQuerythe controller query
CompliancemandatoryThis method must be implemented.
MethodgetControllersByQuery
Description

Gets a list of Controllers matching the given controller query.

Parametersosid.control.ControllerQuerycontrollerQuerythe controller query
Returnosid.control.ControllerListthe returned ControllerList
ErrorsNULL_ARGUMENT controllerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED controllerQuery is not of this service
CompliancemandatoryThis method must be implemented.