Interface DirectionCookbookSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface DirectionCookbookSession
extends OsidSession

This session provides methods to retrieve Direction to Cookbook directions. A Direction may appear in multiple Cookbook catalogs. Each cookbook 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

Modifier and Type	Method	Description
boolean	canLookupDirectionCookbookDirections()	Tests if this user can perform lookups of direction/cookbook 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 Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupDirectionCookbookDirections

boolean canLookupDirectionCookbookDirections()

Tests if this user can perform lookups of direction/cookbook 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 cookbook 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 cookbook 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.