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

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

This session defines views that offer differing behaviors for searching.

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

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

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.
MethodcanSearchInputs
Description

Tests if this user can perform Input 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 inputs 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.
MethodgetInputQuery
Description

Gets an input query.

Returnosid.control.InputQuerythe input query
CompliancemandatoryThis method must be implemented.
MethodgetInputsByQuery
Description

Gets a list of Inputs matching the given input query.

Parametersosid.control.InputQueryinputQuerythe input query
Returnosid.control.InputListthe returned InputList
ErrorsNULL_ARGUMENT inputQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED inputQuery is not of this service
CompliancemandatoryThis method must be implemented.