OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.StepSearchOrder
Implementsosid.OsidGovernatorSearchOrder
osid.OsidSubjugateableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByProcess
Description

Orders the results by process.

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

Tests if a process search order is available.

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

Gets the process search order.

Returnosid.workflow.ProcessSearchOrderthe process search order
ErrorsILLEGAL_STATE supportsProcessSearchOrder() is false
CompliancemandatoryThis method must be implemented.
MethodorderByInitial
Description

Orders the results by initial steps.

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

Orders the results by terminal steps.

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

Orders the results by next state.

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

Tests if a next state search order is available.

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

Gets the next state search order.

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

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

Parametersosid.type.TypestepRecordTypea step record type
Returnosid.workflow.records.StepSearchOrderRecordthe step search order record
ErrorsNULL_ARGUMENT stepRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(stepRecordType) is false
CompliancemandatoryThis method must be implemented.