OSID Logo
OSID Specifications
process package
Version 3.0.0
Release Candidate Preview
Interfaceosid.process.StateQuery
Implementsosid.OsidObjectQuery
Description

This is the query for searching states. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchProcessId
Description

Sets the process Id for this query.

Parametersosid.id.IdprocessIdthe process Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT processId is null
CompliancemandatoryThis method must be implemented.
MethodclearProcessIdTerms
Description

Clears the process Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsProcessQuery
Description

Tests if a ProcessQuery is available.

Returnboolean true if a process query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProcessQuery
Description

Gets the query for a process. Multiple retrievals produce a nested OR term.

Returnosid.process.ProcessQuerythe process query
ErrorsUNIMPLEMENTED supportsProcessQuery() is false
ComplianceoptionalThis method must be implemented if supportsProcessQuery() is true.
MethodclearProcessTerms
Description

Clears the process terms.

CompliancemandatoryThis method must be implemented.
MethodgetStateQueryRecord
Description

Gets the state query record corresponding to the given State record Type. Multiple retrievals produce a nested OR term.

Parametersosid.type.TypestateRecordTypea state record type
Returnosid.process.records.StateQueryRecordthe state query record
ErrorsNULL_ARGUMENT stateRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(stateRecordType) is false
CompliancemandatoryThis method must be implemented.