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

Modifier and Type	Method	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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Modifier and Type	Method	Description
void	orderById(SearchOrderStyle style)	Specifies a preference for ordering the result set by the Id .

Methods inherited from interface OsidObjectSearchOrder

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

Modifier and Type	Method	Description
void	orderByCreateTime(SearchOrderStyle style)	Orders by the timestamp of the first journal entry.
void	orderByCumulativeRating(Id bookId, SearchOrderStyle style)	Orders by the cumulative rating in a given Book .
void	orderByDescription(SearchOrderStyle style)	Specifies a preference for ordering the result set by the description.
void	orderByDisplayName(SearchOrderStyle style)	Specifies a preference for ordering the result set by the display name.
void	orderByGenusType(SearchOrderStyle style)	Specifies a preference for ordering the result set by the genus type.
void	orderByLastModifiedTime(SearchOrderStyle style)	Orders by the timestamp of the last journal entry.
void	orderByState(Id processId, SearchOrderStyle style)	Orders by the state in a given Process .
void	orderByStatistic(Id meterId, SearchOrderStyle style)	Orders by a statistic for a given Meter .

Methods inherited from interface OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByOperational

Modifier and Type	Method	Description
void	orderByActive(SearchOrderStyle style)	Specifies a preference for ordering the result set by the active status.
void	orderByDisabled(SearchOrderStyle style)	Specifies a preference for ordering the result set by the administratively disabled status.
void	orderByOperational(SearchOrderStyle style)	Specifies a preference for ordering the results by the operational status.

Methods inherited from interface OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Modifier and Type	Method	Description
ResourceSearchOrder	getProviderSearchOrder()	Gets the search order interface for a provider.
void	orderByProvider(SearchOrderStyle style)	Specifies a preference for ordering the results by provider.
boolean	supportsProviderSearchOrder()	Tests if a ProviderSearchOrder interface is available.

Method Details

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.