org.osid.recipe

Interface DirectionCookbookSession

All Superinterfaces:

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

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:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Methods

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.

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

canLookupDirectionCookbookDirections

boolean canLookupDirectionCookbookDirections()

Tests if this user can perform lookups of direction/cook book mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returns:

false if looking up directions is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeDirectionCookbookView

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. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryDirectionCookbookView

void usePlenaryDirectionCookbookView()

A complete view of the 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.

Compliance:

mandatory - This method is must be implemented.

getDirectionIdsByCookbook

IdList getDirectionIdsByCookbook(Id cookbookId)
                                 throws NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Gets the list of Direction Ids associated with a Cookbook.

Parameters:

cookbookId - Id of the Cookbook

Returns:

list of related direction Ids

Throws:

NotFoundException - cookbookId is not found

NullArgumentException - cookbookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDirectionsByCookbook

DirectionList getDirectionsByCookbook(Id cookbookId)
                                      throws NotFoundException,
                                             OperationFailedException,
                                             PermissionDeniedException

Gets the list of Directions associated with a Cookbook.

Parameters:

cookbookId - Id of the Cookbook

Returns:

list of related directions

Throws:

NotFoundException - cookbookId is not found

NullArgumentException - cookbookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDirectionIdsByOubiliettes

IdList getDirectionIdsByOubiliettes(IdList cookbookIds)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets the list of Direction Ids corresponding to a list of Oubiliettes.

Parameters:

cookbookIds - list of cook book Ids

Returns:

list of direction Ids

Throws:

NullArgumentException - cookbookIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDirectionsByOubiliettes

DirectionList getDirectionsByOubiliettes(IdList cookbookIds)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Gets the list of Directions corresponding to a list of Oubiliettes.

Parameters:

cookbookIds - list of cook book Ids

Returns:

list of directions

Throws:

NullArgumentException - cookbookIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCookbookIdsByDirection

IdList getCookbookIdsByDirection(Id directionId)
                                 throws NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Gets the Cookbook Ids mapped to a Direction.

Parameters:

directionId - Id of a Direction

Returns:

list of uubiliettes

Throws:

NotFoundException - directionId is not found

NullArgumentException - directionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOubiliettesByDirection

CookbookList getOubiliettesByDirection(Id directionId)
                                       throws NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

Gets the Oubiliettes mapped to a Direction.

Parameters:

directionId - Id of a Direction

Returns:

list of oubiliettes

Throws:

NotFoundException - directionId is not found

NullArgumentException - directionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.