OSID Logo
OSID Specifications
recipe package
Version 3.1.0
Interfaceosid.recipe.DirectionCookbookAssignmentSession
Implementsosid.OsidSession
Used Byosid.recipe.RecipeManager
osid.recipe.RecipeProxyManager
Description

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).

MethodcanAssignDirections
Description

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

Returnboolean false if direction is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodcanAssignDirectionsToCookbook
Description

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

Parametersosid.id.IdcookbookId the Id of the Cookbook
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT cookbookId is null
Compliancemandatory This method must be implemented.
MethodgetAssignableCookbookIds
Description

Gets a list of cookbooks including and under the given cookbook node in which any direction can be assigned.

Parametersosid.id.IdcookbookId the Id of the Cookbook
Returnosid.id.IdList list of assignable cookbook Ids
ErrorsNULL_ARGUMENT cookbookId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAssignableCookbookIdsForDirection
Description

Gets a list of cookbooks including and under the given cookbook node in which a specific direction can be assigned.

Parametersosid.id.IdcookbookId the Id of the Cookbook
osid.id.IddirectionId the Id of the Direction
Returnosid.id.IdList list of assignable cookbook Ids
ErrorsNULL_ARGUMENT cookbookId or directionId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignDirectionToCookbook
Description

Adds an existing Direction to a Cookbook.

Parametersosid.id.IddirectionId the Id of the Direction
osid.id.IdcookbookId the Id of the Cookbook
ErrorsALREADY_EXISTS directionId is already assigned to cookbookId
NOT_FOUND directionId or cookbookId not found
NULL_ARGUMENT directionId or cookbookId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignDirectionFromCookbook
Description

Removes a Direction from a Cookbook.

Parametersosid.id.IddirectionId the Id of the Direction
osid.id.IdcookbookId the Id of the Cookbook
ErrorsNOT_FOUND directionId or cookbookId not found or directionId not assigned to cookbookId
NULL_ARGUMENT directionId or cookbookId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignDirectionToCookbook
Description

Moves a Direction from one Cookbook to another. Mappings to other Cookbooks are unaffected.

Parametersosid.id.IddirectionId the Id of the Direction
osid.id.IdfromCookbookId the Id of the current Cookbook
osid.id.IdtoCookbookId the Id of the destination Cookbook
ErrorsALREADY_EXISTS directionId already assigned to toCookbookId
NOT_FOUND directionId, fromCookbookId, or toCookbookId not found or directionId not mapped to fromCookbookId
NULL_ARGUMENT directionId, fromCookbookId, or toCookbookId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.