OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.ProcessSearchOrder
Implementsosid.OsidGovernatorSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByEnabled
Description

Orders the results by enabled.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByInitialStep
Description

Orders the results by initial step.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsInitialStepSearchOrder
Description

Tests if an initial step search order is available.

Returnboolean true if a step search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetInitialStepSearchOrder
Description

Gets the initial step search order.

Returnosid.workflow.StepSearchOrderthe step search order
ErrorsILLEGAL_STATE supportsInitialStepSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByInitialState
Description

Orders the results by initial state.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsInitialStateSearchOrder
Description

Tests if an initial state search order is available.

Returnboolean true if a state search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetInitialStateSearchOrder
Description

Gets the initial state search order.

Returnosid.process.StateSearchOrderthe state search order
ErrorsILLEGAL_STATE supportsInitialStateSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodgetProcessSearchOrderRecord
Description

Gets the process search order record corresponding to the given process record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TypeprocessRecordTypea process record type
Returnosid.workflow.records.ProcessSearchOrderRecordthe process search order record
ErrorsNULL_ARGUMENT processRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(processRecordType) is false
CompliancemandatoryThis method must be implemented.