public interface CookbookLookupSession extends OsidSession
This session provides methods for retrieving Cookbook
objects. The Cookbook
represents a collection of recipes.
This session defines views that offer differing behaviors when retrieving multiple objects.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupCookbooks()
Tests if this user can perform
Cookbook lookups. |
Cookbook |
getCookbook(Id jouralId)
Gets the
Cookbook specified by its Id. |
CookbookList |
getCookbooks()
Gets all
Cookbooks. |
CookbookList |
getCookbooksByGenusType(Type cookbookGenusType)
Gets an
CookbookList corresponding to the given cook
book genus Type which does not include cook books of
genus types derived from the specified Type. |
CookbookList |
getCookbooksByIds(IdList cookbookIds)
Gets an
CookbookList corresponding to the given
IdList. |
CookbookList |
getCookbooksByParentGenusType(Type cookbookGenusType)
Gets an
CookbookList corresponding to the given cook
book genus Type and include any additional cook books
with genus types derived from the specified Type. |
CookbookList |
getCookbooksByProvider(Id resourceId)
Gets an
CookbookList from the given provider . |
CookbookList |
getCookbooksByRecordType(Type cookbookRecordType)
Gets an
CookbookList containing the given cook book
record Type. |
void |
useComparativeCookbookView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
usePlenaryCookbookView()
A complete view of the
Cookbook returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupCookbooks()
Cookbook
lookups. 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 not offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeCookbookView()
mandatory
- This method is must be implemented. void usePlenaryCookbookView()
Cookbook
returns is desired.
Methods will return what is requested or result in an error. This view
is used when greater precision is desired at the expense of
interoperability.mandatory
- This method is must be implemented. Cookbook getCookbook(Id jouralId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Cookbook
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Cookbook
may have a different Id
than requested, such as
the case where a duplicate Id
was assigned to an
Cookbook
and retained for compatibility.jouralId
- Id
of the Cookbook
NotFoundException
- cookbookId
not foundNullArgumentException
- cookbookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. CookbookList getCookbooksByIds(IdList cookbookIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
CookbookList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
cook books specified in the Id
list, in the order of
the list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Cookbooks
may be omitted from the list and
may present the elements in any order including returning a unique
set.cookbookIds
- the list of Ids
to retrieve Cookbook
listNotFoundException
- an Id was
not foundNullArgumentException
- cookbookIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CookbookList getCookbooksByGenusType(Type cookbookGenusType) throws OperationFailedException, PermissionDeniedException
CookbookList
corresponding to the given cook
book genus Type
which does not include cook books of
genus types derived from the specified Type.
In plenary
mode, the returned list contains all known cook books or an error
results. Otherwise, the returned list may contain only those cook
books that are accessible through this session.cookbookGenusType
- a cook book genus type Cookbook
listNullArgumentException
- cookbookGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CookbookList getCookbooksByParentGenusType(Type cookbookGenusType) throws OperationFailedException, PermissionDeniedException
CookbookList
corresponding to the given cook
book genus Type
and include any additional cook books
with genus types derived from the specified Type.
In
plenary mode, the returned list contains all known cook books or an
error results. Otherwise, the returned list may contain only those
cook books that are accessible through this session.cookbookGenusType
- a cook book genus type Cookbook
listNullArgumentException
- cookbookGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CookbookList getCookbooksByRecordType(Type cookbookRecordType) throws OperationFailedException, PermissionDeniedException
CookbookList
containing the given cook book
record Type.
In plenary mode, the returned list
contains all known cook books or an error results. Otherwise, the
returned list may contain only those cook books that are accessible
through this session.cookbookRecordType
- a cook book record type Cookbook
listNullArgumentException
- cookbookRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CookbookList getCookbooksByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
CookbookList
from the given provider .
In plenary mode, the returned list contains all known cook
books or an error results. Otherwise, the returned list may contain
only those cook books that are accessible through this session.resourceId
- a resource Id
Cookbook
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CookbookList getCookbooks() throws OperationFailedException, PermissionDeniedException
Cookbooks.
In plenary mode, the returned list
contains all known cook books or an error results. Otherwise, the
returned list may contain only those cook books that are accessible
through this session. Cookbooks
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.