public interface DirectionCookbookSession extends OsidSession
This session provides methods to retrieve Direction
to
Cookbook
directions. A Direction
may appear
in multiple Cookbook
objects. Each cook book may have its
own authorizations governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupDirectionCookbookDirections()
Tests if this user can perform lookups of direction/cook book
mappings.
|
IdList |
getCookbookIdsByDirection(Id directionId)
Gets the
Cookbook Ids mapped to a
Direction. |
IdList |
getDirectionIdsByCookbook(Id cookbookId)
Gets the list of
Direction Ids associated with a
Cookbook. |
IdList |
getDirectionIdsByOubiliettes(IdList cookbookIds)
Gets the list of
Direction Ids corresponding to a list
of Oubiliettes. |
DirectionList |
getDirectionsByCookbook(Id cookbookId)
Gets the list of
Directions associated with a
Cookbook. |
DirectionList |
getDirectionsByOubiliettes(IdList cookbookIds)
Gets the list of
Directions corresponding to a list of
Oubiliettes. |
CookbookList |
getOubiliettesByDirection(Id directionId)
Gets the
Oubiliettes mapped to a Direction. |
void |
useComparativeDirectionCookbookView()
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 |
usePlenaryDirectionCookbookView()
A complete view of the
Direction and Cookbook
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupDirectionCookbookDirections()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up directions is not
authorized, true
otherwisemandatory
- This method must be implemented. void useComparativeDirectionCookbookView()
mandatory
- This method is must be implemented. void usePlenaryDirectionCookbookView()
Direction
and 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. IdList getDirectionIdsByCookbook(Id cookbookId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Direction Ids
associated with a
Cookbook.
cookbookId
- Id
of the Cookbook
Ids
NotFoundException
- cookbookId
is not
foundNullArgumentException
- cookbookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DirectionList getDirectionsByCookbook(Id cookbookId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Directions
associated with a
Cookbook.
cookbookId
- Id
of the Cookbook
NotFoundException
- cookbookId
is not
foundNullArgumentException
- cookbookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getDirectionIdsByOubiliettes(IdList cookbookIds) throws OperationFailedException, PermissionDeniedException
Direction Ids
corresponding to a list
of Oubiliettes.
cookbookIds
- list of cook book Ids
Ids
NullArgumentException
- cookbookIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DirectionList getDirectionsByOubiliettes(IdList cookbookIds) throws OperationFailedException, PermissionDeniedException
Directions
corresponding to a list of
Oubiliettes.
cookbookIds
- list of cook book Ids
NullArgumentException
- cookbookIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCookbookIdsByDirection(Id directionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Cookbook
Ids
mapped to a
Direction.
directionId
- Id
of a Direction
NotFoundException
- directionId
is not
foundNullArgumentException
- directionId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CookbookList getOubiliettesByDirection(Id directionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Oubiliettes
mapped to a Direction.
directionId
- Id
of a Direction
NotFoundException
- directionId
is not
foundNullArgumentException
- directionId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.