org.osid.recipe

Interface CookbookQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

CookbookSearchSession

public interface CookbookQuerySession
extends OsidSession

This session provides methods for searching Cookbook objects. The search query is constructed using the CookbookQuery. The cook book record Type also specifies the record for the cook book query.

Cookbooks may have a query record indicated by their respective record types. The query record is accessed via the CookbookQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchCookbooks() Tests if this user can perform Cookbook searches.
CookbookQuery	getCookbookQuery() Gets a cook book query.
CookbookList	getCookbooksByQuery(CookbookQuery cookbookQuery) Gets a list of Cookbooks matching the given search.

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

canSearchCookbooks

boolean canSearchCookbooks()

Tests if this user can perform Cookbook searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 search operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getCookbookQuery

CookbookQuery getCookbookQuery()

Gets a cook book query.

Returns:

the cook book query

Compliance:

mandatory - This method must be implemented.

getCookbooksByQuery

CookbookList getCookbooksByQuery(CookbookQuery cookbookQuery)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Gets a list of Cookbooks matching the given search.

Parameters:

cookbookQuery - the cook book query

Returns:

the returned CookbookList

Throws:

NullArgumentException - cookbookQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - cookbookQuery is not of this service

Compliance:

mandatory - This method must be implemented.