Interface DirectionSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSubjugateableSearchOrder, Suppliable

public interface DirectionSearchOrder
extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
DirectionSearchOrderRecord	getDirectionSearchOrderRecord(Type directionRecordType)	Gets the direction search order record corresponding to the given direction record Type .
RecipeSearchOrder	getRecipeSearchOrder()	Gets the recipe search order.
void	orderByEstimatedDuration(SearchOrderStyle style)	Orders the results by the duration.
void	orderByRecipe(SearchOrderStyle style)	Orders the results by recipe.
boolean	supportsRecipeSearchOrder()	Tests if a recipe 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 .

Method Details

orderByRecipe

void orderByRecipe(SearchOrderStyle style)

Orders the results by recipe.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsRecipeSearchOrder

boolean supportsRecipeSearchOrder()

Tests if a recipe search order is available.

Returns:

true if a recipe search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRecipeSearchOrder

RecipeSearchOrder getRecipeSearchOrder()

Gets the recipe search order.

Returns:

the recipe search order

Throws:

IllegalStateException - supportsRecipeSearchOrder() is false

Compliance:

mandatory - This method must be implemented.

orderByEstimatedDuration

void orderByEstimatedDuration(SearchOrderStyle style)

Orders the results by the duration.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getDirectionSearchOrderRecord

DirectionSearchOrderRecord getDirectionSearchOrderRecord(Type directionRecordType)
                                                  throws OperationFailedException,
PermissionDeniedException

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

Parameters:

directionRecordType - a direction record type

Returns:

the direction search order record

Throws:

NullArgumentException - directionRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(directionRecordType) is false

Compliance:

mandatory - This method must be implemented.