public interface RecipeSmartCookbookSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A RecipeQuery
can be retrieved from this session
and mapped to this Cookbook
to create a virtual collection
of Recipes.
The recipes may be sequenced using the
RecipeSearchOrder
from this session.
This Cookbook
has a default query that matches any
recipe and a default search order that specifies no sequencing. The
queries may be examined using a RecipeQueryInspector.
The
query may be modified by converting the inspector back to a
RecipeQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyRecipeQuery(RecipeQuery recipeQuery)
Applies a recipe query to this cookbook.
|
void |
applyRecipeSequencing(RecipeSearchOrder recipeSearchOrder)
Applies a recipe search order to this cookbook.
|
boolean |
canManageSmartCookbooks()
Tests if this user can manage smart cook books.
|
Cookbook |
getCookbook()
Gets the
Cookbook associated with this session. |
Id |
getCookbookId()
Gets the
Cookbook Id associated with
this session. |
RecipeQuery |
getRecipeQuery()
Gets a recipe query.
|
RecipeQuery |
getRecipeQueryFromInspector(RecipeQueryInspector recipeQueryInspector)
Gets a recipe query from an inspector.
|
RecipeSearchOrder |
getRecipeSearchOrder()
Gets a recipe search order.
|
RecipeQueryInspector |
inspectRecipeQuery()
Gets a recipe query inspector for this cookbook.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCookbookId()
Cookbook
Id
associated with
this session. Cookbook Id
associated with this sessionmandatory
- This method must be implemented. Cookbook getCookbook() throws OperationFailedException, PermissionDeniedException
Cookbook
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartCookbooks()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart cook book management is not
authorized, true
otherwisemandatory
- This method must be implemented. RecipeQuery getRecipeQuery()
mandatory
- This method must be implemented. RecipeSearchOrder getRecipeSearchOrder()
mandatory
- This method must be implemented. void applyRecipeQuery(RecipeQuery recipeQuery) throws OperationFailedException, PermissionDeniedException
recipeQuery
- the recipe queryNullArgumentException
- recipeQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- recipeQuery
not
of this servicemandatory
- This method must be implemented. RecipeQueryInspector inspectRecipeQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyRecipeSequencing(RecipeSearchOrder recipeSearchOrder) throws OperationFailedException, PermissionDeniedException
recipeSearchOrder
- the recipe search orderNullArgumentException
- recipeSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- recipeSearchOrder
not of this servicemandatory
- This method must be implemented. RecipeQuery getRecipeQueryFromInspector(RecipeQueryInspector recipeQueryInspector)
recipeQueryInspector
- a recipe query inspectorNullArgumentException
- recipeQueryInspector
is null
UnsupportedException
- recipeQueryInspector
is not of this servicemandatory
- This method must be implemented.