org.osid.recipe

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

Methods

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

Method Detail

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.