Interface RecipeSearchOrder
- All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable
An interface for specifying the ordering of search results.
-
Method Summary
Modifier and TypeMethodDescriptiongetRecipeSearchOrderRecord(Type recipeRecordType) Gets the recipe search order record corresponding to the given recipe recordType.voidOrders the results by total estimated duration.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeModifier and TypeMethodDescriptionGets the record types available in this object.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from interface OsidIdentifiableSearchOrder
orderByIdModifier and TypeMethodDescriptionvoidorderById(SearchOrderStyle style) Specifies a preference for ordering the result set by theId.Methods inherited from interface OsidObjectSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatisticModifier and TypeMethodDescriptionvoidOrders by the timestamp of the first journal entry.voidorderByCumulativeRating(Id bookId, SearchOrderStyle style) Orders by the cumulative rating in a givenBook.voidSpecifies a preference for ordering the result set by the description.voidSpecifies a preference for ordering the result set by the display name.voidorderByGenusType(SearchOrderStyle style) Specifies a preference for ordering the result set by the genus type.voidOrders by the timestamp of the last journal entry.voidorderByState(Id processId, SearchOrderStyle style) Orders by the state in a givenProcess.voidorderByStatistic(Id meterId, SearchOrderStyle style) Orders by a statistic for a givenMeter.Methods inherited from interface OsidSourceableSearchOrder
getProviderSearchOrder, orderByProvider, supportsProviderSearchOrderModifier and TypeMethodDescriptionGets the search order interface for a provider.voidorderByProvider(SearchOrderStyle style) Specifies a preference for ordering the results by provider.booleanTests if aProviderSearchOrderinterface is available.
-
Method Details
-
orderByTotalEstimatedDuration
Orders the results by total estimated duration.- Parameters:
style- search order style- Throws:
NullArgumentException-styleisnull- 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 recordType. Multiple retrievals return the same underlying object.- Parameters:
recipeRecordType- a recipe record type- Returns:
- the recipe search order record
- Throws:
NullArgumentException-recipeRecordTypeisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure occurredUnsupportedException-hasRecordType(recipeRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-