org.osid.recipe

Interface RecipeSmartCookbookSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getCookbookId

Id getCookbookId()

Gets the Cookbook Id associated with this session.

Returns:

the Cookbook Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCookbook

Cookbook getCookbook()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets the Cookbook associated with this session.

Returns:

the cookbook

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartCookbooks

boolean canManageSmartCookbooks()

Tests if this user can manage smart cook books. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.

Returns:

false if smart cook book management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getRecipeQuery

RecipeQuery getRecipeQuery()

Gets a recipe query.

Returns:

the recipe query

Compliance:

mandatory - This method must be implemented.

getRecipeSearchOrder

RecipeSearchOrder getRecipeSearchOrder()

Gets a recipe search order.

Returns:

the recipe search order

Compliance:

mandatory - This method must be implemented.

applyRecipeQuery

void applyRecipeQuery(RecipeQuery recipeQuery)
                      throws OperationFailedException,
                             PermissionDeniedException

Applies a recipe query to this cookbook.

Parameters:

recipeQuery - the recipe query

Throws:

NullArgumentException - recipeQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - recipeQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectRecipeQuery

RecipeQueryInspector inspectRecipeQuery()
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets a recipe query inspector for this cookbook.

Returns:

the recipe query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyRecipeSequencing

void applyRecipeSequencing(RecipeSearchOrder recipeSearchOrder)
                           throws OperationFailedException,
                                  PermissionDeniedException

Applies a recipe search order to this cookbook.

Parameters:

recipeSearchOrder - the recipe search order

Throws:

NullArgumentException - recipeSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - recipeSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getRecipeQueryFromInspector

RecipeQuery getRecipeQueryFromInspector(RecipeQueryInspector recipeQueryInspector)

Gets a recipe query from an inspector.

Parameters:

recipeQueryInspector - a recipe query inspector

Returns:

the recipe query

Throws:

NullArgumentException - recipeQueryInspector is null

UnsupportedException - recipeQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.