OSID Logo
OSID Specifications
process package
Version 3.0.0
Release Candidate Preview
Interfaceosid.process.ProcessQuerySession
Implementsosid.OsidSession
Description

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

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

MethodcanSearchProcesses
Description

Tests if this user can perform Process 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.
MethodgetProcessQuery
Description

Gets a process query. The returned query will not have an extension query.

Returnosid.process.ProcessQuerythe process query
CompliancemandatoryThis method must be implemented.
MethodgetProcessesByQuery
Description

Gets a list of Processes matching the given process query.

Parametersosid.process.ProcessQueryprocessQuerythe process query
Returnosid.process.ProcessListthe returned ProcessList
ErrorsNULL_ARGUMENT processQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDa processQuery is not of this service
CompliancemandatoryThis method must be implemented.