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

This session provides methods to re-assign Procedures to Cookbooks . A Procedure may map to multiple Cookbooks and removing the last reference to a Procedure 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 Procedure to another Cookbook is not a copy operation (eg: does not change its Id ).

MethodcanAssignProcedures
Description

Tests if this user can alter procedure/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 assignment operations to unauthorized users.

Returnbooleanfalse if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignProceduresToCookbook
Description

Tests if this user can alter procedure/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 assignment operations to unauthorized users.

Parametersosid.id.IdcookbookIdthe Id of the Cookbook
Returnbooleanfalse if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENTcookbookId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableCookbookIds
Description

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

Parametersosid.id.IdcookbookIdthe Id of the Cookbook
Returnosid.id.IdListlist of assignable cookbook Ids
ErrorsNULL_ARGUMENTcookbookId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableCookbookIdsForProcedure
Description

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

Parametersosid.id.IdcookbookIdthe Id of the Cookbook
osid.id.IdprocedureIdthe Id of the Procedure
Returnosid.id.IdListlist of assignable cookbook Ids
ErrorsNULL_ARGUMENTcookbookId or procedureId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignProcedureToCookbook
Description

Adds an existing Procedure to an Cookbook .

Parametersosid.id.IdprocedureIdthe Id of the Procedure
osid.id.IdcookbookIdthe Id of the Cookbook
ErrorsALREADY_EXISTSprocedureId is already assigned to cookbookId
NOT_FOUNDprocedureId or cookbookId not found
NULL_ARGUMENTprocedureId or cookbookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignProcedureFromCookbook
Description

Removes a Procedure from an Cookbook .

Parametersosid.id.IdprocedureIdthe Id of the Procedure
osid.id.IdcookbookIdthe Id of the Cookbook
ErrorsNOT_FOUNDprocedureId or cookbookId not found or proecdureId not assigned to cookbookId
NULL_ARGUMENTprocedureId or cookbookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignProcedureToCookbook
Description

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

Parametersosid.id.IdprocedureIdthe Id of the Procedure
osid.id.IdfromCookbookIdthe Id of the current Cookbook
osid.id.IdtoCookbookIdthe Id of the destination Cookbook
ErrorsALREADY_EXISTSprocedureId already assigned to toCookbookId
NOT_FOUNDprocedureId, fromCookbookId , or toCookbookId not found or procedureId not mapped to fromCookbookId
NULL_ARGUMENTprocedureId, fromCookbookId , or toCookbookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.