org.osid.recipe

Interface RecipeSearchOrder

All Superinterfaces:

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

public interface RecipeSearchOrder
extends OsidObjectSearchOrder, OsidSourceableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
RecipeSearchOrderRecord	getRecipeSearchOrderRecord(Type recipeRecordType) Gets the recipe search order record corresponding to the given recipe record Type.
void	orderByTotalEstimatedDuration(SearchOrderStyle style) Orders the results by total estimated duration.

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.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

orderByTotalEstimatedDuration

void orderByTotalEstimatedDuration(SearchOrderStyle style)

Orders the results by total estimated duration.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getRecipeSearchOrderRecord

RecipeSearchOrderRecord getRecipeSearchOrderRecord(Type recipeRecordType)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

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

Parameters:

recipeRecordType - a recipe record type

Returns:

the recipe search order record

Throws:

NullArgumentException - recipeRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(recipeRecordType) is false

Compliance:

mandatory - This method must be implemented.