OSID Logo
OSID Specifications
process package
Version 3.0.0
Release Candidate Preview
Interfaceosid.process.ProcessSearch
Implementsosid.OsidSearch
Description

The interface for governing process searches.

MethodsearchAmongProcesses
Description

Execute this search among the given list of processes.

Parametersosid.id.IdListprocessIdslist of processes
ErrorsNULL_ARGUMENT processIds is null
CompliancemandatoryThis method must be implemented.
MethodorderProcessResults
Description

Specify an ordering to the search results.

Parametersosid.process.ProcessSearchOrderprocessSearchOrderprocess search order
ErrorsNULL_ARGUMENT processSearchOrder is null
UNSUPPORTED processSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProcessSearchRecord
Description

Gets the process search record corresponding to the given process search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeprocessSearchRecordTypea process search record type
Returnosid.process.records.ProcessSearchRecordthe process search record
ErrorsNULL_ARGUMENT processSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(processSearchRecordType) is false
CompliancemandatoryThis method must be implemented.