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

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

getProcessesByQuery() is the basic search method and returns a list of Process objects.A more advanced search may be performed with getProcessesBySearch(). It accepts a ProcessSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getProcessesBySearch() returns a ProcessSearchResults that can be used to access the resulting ProcessList or be used to perform a search within the result set through ProcessSearch.

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

MethodgetProcessSearch
Description

Gets a process search.

Returnosid.process.ProcessSearchthe process search
CompliancemandatoryThis method must be implemented.
MethodgetProcessSearchOrder
Description

Gets a process search order. The ProcessSearchOrder is supplied to a ProcessSearch to specify the ordering of results.

Returnosid.process.ProcessSearchOrderthe process search order
CompliancemandatoryThis method must be implemented.
MethodgetProcessesBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.process.ProcessQueryprocessQuerythe process query
osid.process.ProcessSearchprocessSearchthe process search
Returnosid.process.ProcessSearchResultsthe search results
ErrorsNULL_ARGUMENT processQuery or processSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED processQuery or processSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProcessQueryFromInspector
Description

Gets a process query from an inspector. The inspector is available from a ProcessSearchResults.

Parametersosid.process.ProcessQueryInspectorprocessQueryInspectora proces query inspector
Returnosid.process.ProcessQuerythe process query
ErrorsNULL_ARGUMENT processQueryInspector is null
UNSUPPORTED processQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.