org.osid.recipe

Interface DirectionCookbookAssignmentSession

All Superinterfaces:

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

public interface DirectionCookbookAssignmentSession
extends OsidSession

This session provides methods to re-assign Directions to Cookbook mappings. A Direction may appear in multiple Cookbook objects and removing the last reference to a Direction is the equivalent of deleting it. Each Cookbook may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Direction to another Cookbook is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignDirectionToCookbook(Id directionId, Id cookbookId) Adds an existing Direction to a Cookbook.
boolean	canAssignDirections() Tests if this user can alter direction/cook book mappings.
boolean	canAssignDirectionsToCookbook(Id cookbookId) Tests if this user can alter direction/cook book mappings.
IdList	getAssignableCookbookIds(Id cookbookId) Gets a list of oubiliettes including and under the given cook book node in which any direction can be assigned.
IdList	getAssignableCookbookIdsForDirection(Id cookbookId, Id directionId) Gets a list of oubiliettes including and under the given cook book node in which a specific direction can be assigned.
void	unassignDirectionFromCookbook(Id directionId, Id cookbookId) Removes a Direction from a Cookbook.

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

canAssignDirections

boolean canAssignDirections()

Tests if this user can alter direction/cook book mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 direction is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignDirectionsToCookbook

boolean canAssignDirectionsToCookbook(Id cookbookId)

Tests if this user can alter direction/cook book mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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.

Parameters:

cookbookId - the Id of the Cookbook

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - cookbookId is null

Compliance:

mandatory - This method must be implemented.

getAssignableCookbookIds

IdList getAssignableCookbookIds(Id cookbookId)
                                throws OperationFailedException

Gets a list of oubiliettes including and under the given cook book node in which any direction can be assigned.

Parameters:

cookbookId - the Id of the Cookbook

Returns:

list of assignable cook book Ids

Throws:

NullArgumentException - cookbookId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableCookbookIdsForDirection

IdList getAssignableCookbookIdsForDirection(Id cookbookId,
                                          Id directionId)
                                            throws OperationFailedException

Gets a list of oubiliettes including and under the given cook book node in which a specific direction can be assigned.

Parameters:

cookbookId - the Id of the Cookbook

directionId - the Id of the Direction

Returns:

list of assignable cook book Ids

Throws:

NullArgumentException - cookbookId or directionId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignDirectionToCookbook

void assignDirectionToCookbook(Id directionId,
                             Id cookbookId)
                               throws AlreadyExistsException,
                                      NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

Adds an existing Direction to a Cookbook.

Parameters:

directionId - the Id of the Direction

cookbookId - the Id of the Cookbook

Throws:

AlreadyExistsException - directionId is already assigned to cookbookId

NotFoundException - directionId or cookbookId not found

NullArgumentException - directionId or cookbookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignDirectionFromCookbook

void unassignDirectionFromCookbook(Id directionId,
                                 Id cookbookId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Removes a Direction from a Cookbook.

Parameters:

directionId - the Id of the Direction

cookbookId - the Id of the Cookbook

Throws:

NotFoundException - directionId or cookbookId not found or directionId not assigned to cookbookId

NullArgumentException - directionId or cookbookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.