org.osid.workflow

Interface StepSearchOrder

All Superinterfaces:

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

public interface StepSearchOrder
extends OsidGovernatorSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
StateSearchOrder	getNextStateSearchOrder() Gets the next state search order.
ProcessSearchOrder	getProcessSearchOrder() Gets the process search order.
StepSearchOrderRecord	getStepSearchOrderRecord(Type stepRecordType) Gets the step search order record corresponding to the given step record Type.
void	orderByInitial(SearchOrderStyle style) Orders the results by initial steps.
void	orderByNextState(SearchOrderStyle style) Orders the results by next state.
void	orderByProcess(SearchOrderStyle style) Orders the results by process.
void	orderByTerminal(SearchOrderStyle style) Orders the results by terminal steps.
boolean	supportsNextStateSearchOrder() Tests if a next state search order is available.
boolean	supportsProcessSearchOrder() Tests if a process 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, orderByEnabled, orderByOperational

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

orderByProcess

void orderByProcess(SearchOrderStyle style)

Orders the results by process.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsProcessSearchOrder

boolean supportsProcessSearchOrder()

Tests if a process search order is available.

Returns:

true if a process search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProcessSearchOrder

ProcessSearchOrder getProcessSearchOrder()

Gets the process search order.

Returns:

the process search order

Throws:

IllegalStateException - supportsProcessSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByInitial

void orderByInitial(SearchOrderStyle style)

Orders the results by initial steps.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByTerminal

void orderByTerminal(SearchOrderStyle style)

Orders the results by terminal steps.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByNextState

void orderByNextState(SearchOrderStyle style)

Orders the results by next state.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsNextStateSearchOrder

boolean supportsNextStateSearchOrder()

Tests if a next state search order is available.

Returns:

true if a state search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getNextStateSearchOrder

StateSearchOrder getNextStateSearchOrder()

Gets the next state search order.

Returns:

the state search order

Throws:

IllegalStateException - supportsNextStateSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

getStepSearchOrderRecord

StepSearchOrderRecord getStepSearchOrderRecord(Type stepRecordType)
                                               throws OperationFailedException

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

Parameters:

stepRecordType - a step record type

Returns:

the step search order record

Throws:

NullArgumentException - stepRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stepRecordType) is false

Compliance:

mandatory - This method must be implemented.