public interface RecipeSearchSession extends RecipeQuerySession
This session provides methods for searching among Recipe
objects. The search query is constructed using the RecipeQuery.
getRecipesByQuery()
is the basic search method and
returns a list of Recipes.
A more advanced search may be
performed with getRecipesBySearch().
It accepts a
RecipeSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getRecipesBySearch()
returns a
RecipeSearchResults
that can be used to access the resulting
RecipeList
or be used to perform a search within the result
set through RecipeSearch.
This session defines views that offer differing behaviors for searching.
Recipes may have a query record indicated by their respective record
types. The query record is accessed via the RecipeQuery.
Modifier and Type | Method and Description |
---|---|
RecipeQuery |
getRecipeQueryFromInspector(RecipeQueryInspector recipeQueryInspector)
Gets a recipe query from an inspector.
|
RecipeSearchResults |
getRecipesBySearch(RecipeQuery recipeQuery,
RecipeSearch recipeSearch)
Gets the search results matching the given search query using the
given search.
|
RecipeSearch |
getRecipeSearch()
Gets a recipe search.
|
RecipeSearchOrder |
getRecipeSearchOrder()
Gets a recipe search order.
|
canSearchRecipes, getCookbook, getCookbookId, getRecipeQuery, getRecipesByQuery, useFederatedCookbookView, useIsolatedCookbookView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
RecipeSearch getRecipeSearch()
mandatory
- This method must be implemented. RecipeSearchOrder getRecipeSearchOrder()
RecipeSearchOrder
is
supplied to a RecipeSearch
to specify the ordering of
results.mandatory
- This method must be implemented. RecipeSearchResults getRecipesBySearch(RecipeQuery recipeQuery, RecipeSearch recipeSearch) throws OperationFailedException, PermissionDeniedException
recipeQuery
- the recipe queryrecipeSearch
- the recipe searchNullArgumentException
- recipeQuery
or
recipeSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- recipeQuery
or
recipeSearch
is not of this servicemandatory
- This method must be implemented. RecipeQuery getRecipeQueryFromInspector(RecipeQueryInspector recipeQueryInspector)
RecipeSearchResults.
recipeQueryInspector
- a recipe query inspectorNullArgumentException
- recipeQueryInspector
is null
UnsupportedException
- recipeQueryInspector
is not of this servicemandatory
- This method must be implemented.