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

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

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.