public interface DirectionSearchOrder extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder
An interface for specifying the ordering of search results.
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.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByRecipe(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsRecipeSearchOrder()
true
if a recipe search order is available,
false
otherwisemandatory
- This method must be implemented. RecipeSearchOrder getRecipeSearchOrder()
IllegalStateException
-
supportsRecipeSearchOrder()
is false
mandatory
- This method must be implemented. void orderByEstimatedDuration(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. DirectionSearchOrderRecord getDirectionSearchOrderRecord(Type directionRecordType) throws OperationFailedException, PermissionDeniedException
Type.
Multiple retrievals return the
same underlying object.directionRecordType
- a direction record typeNullArgumentException
- directionRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(directionRecordType)
is false
mandatory
- This method must be implemented.