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.
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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchCookbooks()
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. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. CookbookQuery getCookbookQuery()
mandatory
- This method must be implemented. CookbookList getCookbooksByQuery(CookbookQuery cookbookQuery) throws OperationFailedException, PermissionDeniedException
Cookbooks
matching the given search.cookbookQuery
- the cook book query CookbookList
NullArgumentException
- cookbookQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- cookbookQuery
is
not of this servicemandatory
- This method must be implemented.