OSID Logo
OSID Specifications
process package
Version 3.1.0
Interfaceosid.process.ProcessSearchSession
Implementsosid.process.ProcessQuerySession
Used Byosid.process.ProcessManager
osid.process.ProcessProxyManager
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.ProcessSearch the process search
Compliancemandatory This 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.ProcessSearchOrder the process search order
Compliancemandatory This method must be implemented.
MethodgetProcessesBySearch
Description

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

Parametersosid.process.ProcessQueryprocessQuery the process query
osid.process.ProcessSearchprocessSearch the process search
Returnosid.process.ProcessSearchResults the search results
ErrorsNULL_ARGUMENT processQuery or processSearch is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED processQuery or processSearch is not of this service
Compliancemandatory This method must be implemented.
MethodgetProcessQueryFromInspector
Description

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

Parametersosid.process.ProcessQueryInspectorprocessQueryInspector a proces query inspector
Returnosid.process.ProcessQuery the process query
ErrorsNULL_ARGUMENT processQueryInspector is null
UNSUPPORTED processQueryInspector is not of this service
Compliancemandatory This method must be implemented.