org.osid.workflow

Interface ProcessSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidGovernatorSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface ProcessSearchOrder
extends OsidGovernatorSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
StateSearchOrder	getInitialStateSearchOrder() Gets the initial state search order.
StepSearchOrder	getInitialStepSearchOrder() Gets the initial step search order.
ProcessSearchOrderRecord	getProcessSearchOrderRecord(Type processRecordType) Gets the process search order record corresponding to the given process record Type.
void	orderByEnabled(SearchOrderStyle style) Orders the results by enabled.
void	orderByInitialState(SearchOrderStyle style) Orders the results by initial state.
void	orderByInitialStep(SearchOrderStyle style) Orders the results by initial step.
boolean	supportsInitialStateSearchOrder() Tests if an initial state search order is available.
boolean	supportsInitialStepSearchOrder() Tests if an initial step search order is available.

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByOperational

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

orderByEnabled

void orderByEnabled(SearchOrderStyle style)

Orders the results by enabled.

Specified by:

orderByEnabled in interface OsidOperableSearchOrder

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByInitialStep

void orderByInitialStep(SearchOrderStyle style)

Orders the results by initial step.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsInitialStepSearchOrder

boolean supportsInitialStepSearchOrder()

Tests if an initial step search order is available.

Returns:

true if a step search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getInitialStepSearchOrder

StepSearchOrder getInitialStepSearchOrder()

Gets the initial step search order.

Returns:

the step search order

Throws:

IllegalStateException - supportsInitialStepSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByInitialState

void orderByInitialState(SearchOrderStyle style)

Orders the results by initial state.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsInitialStateSearchOrder

boolean supportsInitialStateSearchOrder()

Tests if an initial state search order is available.

Returns:

true if a state search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getInitialStateSearchOrder

StateSearchOrder getInitialStateSearchOrder()

Gets the initial state search order.

Returns:

the state search order

Throws:

IllegalStateException - supportsInitialStateSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

getProcessSearchOrderRecord

ProcessSearchOrderRecord getProcessSearchOrderRecord(Type processRecordType)
                                                     throws OperationFailedException

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

Parameters:

processRecordType - a process record type

Returns:

the process search order record

Throws:

NullArgumentException - processRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(processRecordType) is false

Compliance:

mandatory - This method must be implemented.