Interface CookbookHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CookbookHierarchyDesignSession
extends OsidSession

This session manages a hierarchy of cookbooks. Cookbooks may be organized into a hierarchy for organizing or federating. A parent Cookbook includes all of the procedures of its children such that a single root node contains all of the procedures of the federation.

Method Summary

Modifier and Type	Method	Description
void	addChildCookbook(Id cookbookId, Id childId)	Adds a child to a cookbook.
void	addRootCookbook(Id cookbookId)	Adds a root cookbook.
boolean	canModifyCookbookHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getCookbookHierarchy()	Gets the hierarchy associated with this session.
Id	getCookbookHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildCookbook(Id cookbookId, Id childId)	Removes a child from a cookbook.
void	removeChildCookbooks(Id cookbookId)	Removes all children from a cookbook.
void	removeRootCookbook(Id cookbookId)	Removes a root cookbook.

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

getCookbookHierarchyId

Id getCookbookHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCookbookHierarchy

Hierarchy getCookbookHierarchy()
                        throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canModifyCookbookHierarchy

boolean canModifyCookbookHierarchy()

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returns:

false if changing this hierarchy is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addRootCookbook

void addRootCookbook(Id cookbookId)
              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root cookbook.

Parameters:

cookbookId - the Id of a cookbook

Throws:

AlreadyExistsException - cookbookId is already in hierarchy

NotFoundException - cookbookId is not found

NullArgumentException - cookbookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootCookbook

void removeRootCookbook(Id cookbookId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root cookbook.

Parameters:

cookbookId - the Id of a cookbook

Throws:

NotFoundException - cookbookId is not a root

NullArgumentException - cookbookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildCookbook

void addChildCookbook(Id cookbookId,
 Id childId)
               throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a cookbook.

Parameters:

cookbookId - the Id of a cookbook

childId - the Id of the new child

Throws:

AlreadyExistsException - cookbookId is already a parent of childId

NotFoundException - cookbookId or childId not found

NullArgumentException - cookbookId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildCookbook

void removeChildCookbook(Id cookbookId,
 Id childId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a cookbook.

Parameters:

cookbookId - the Id of a cookbook

childId - the Id of the new child

Throws:

NotFoundException - cookbookId not a parent of childId

NullArgumentException - cookbookId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildCookbooks

void removeChildCookbooks(Id cookbookId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a cookbook.

Parameters:

cookbookId - the Id of a cookbook

Throws:

NotFoundException - cookbookId not found

NullArgumentException - cookbookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.