org.osid.recipe

Interface ProcedureCookbookAssignmentSession

All Superinterfaces:

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

public interface ProcedureCookbookAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignProcedureToCookbook(Id procedureId, Id cookbookId) Adds an existing Procedure to an Cookbook.
boolean	canAssignProcedures() Tests if this user can alter procedure/cook book mappings.
boolean	canAssignProceduresToCookbook(Id cookbookId) Tests if this user can alter procedure/cook book mappings.
IdList	getAssignableCookbookIds(Id cookbookId) Gets a list of cook books including and under the given cook book node in which any procedure can be assigned.
IdList	getAssignableCookbookIdsForProcedure(Id cookbookId, Id procedureId) Gets a list of cook books including and under the given cook book node in which a specific procedure can be assigned.
void	unassignProcedureFromCookbook(Id procedureId, Id cookbookId) Removes a Procedure from an 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

canAssignProcedures

boolean canAssignProcedures()

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

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignProceduresToCookbook

boolean canAssignProceduresToCookbook(Id cookbookId)

Tests if this user can alter procedure/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 assignment 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 cook books including and under the given cook book node in which any procedure 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.

getAssignableCookbookIdsForProcedure

IdList getAssignableCookbookIdsForProcedure(Id cookbookId,
                                          Id procedureId)
                                            throws OperationFailedException

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

Parameters:

cookbookId - the Id of the Cookbook

procedureId - the Id of the Procedure

Returns:

list of assignable cook book Ids

Throws:

NullArgumentException - cookbookId or procedureId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignProcedureToCookbook

void assignProcedureToCookbook(Id procedureId,
                             Id cookbookId)
                               throws AlreadyExistsException,
                                      NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

Adds an existing Procedure to an Cookbook.

Parameters:

procedureId - the Id of the Procedure

cookbookId - the Id of the Cookbook

Throws:

AlreadyExistsException - procedureId is already assigned to cookbookId

NotFoundException - procedureId or cookbookId not found

NullArgumentException - procedureId or cookbookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignProcedureFromCookbook

void unassignProcedureFromCookbook(Id procedureId,
                                 Id cookbookId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Removes a Procedure from an Cookbook.

Parameters:

procedureId - the Id of the Procedure

cookbookId - the Id of the Cookbook

Throws:

NotFoundException - procedureId or cookbookId not found or proecdureId not assigned to cookbookId

NullArgumentException - procedureId or cookbookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.