public interface CookbookHierarchyDesignSession extends OsidSession
This session manages a hierarchy of cook books. 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.
Modifier and Type | Method and 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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCookbookHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getCookbookHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyCookbookHierarchy()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer these operations to an
unauthorized user. false
if changing this hierarchy is not
authorized, true
otherwisemandatory
- This method must be implemented. void addRootCookbook(Id cookbookId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
cookbookId
- the Id
of a cookbookAlreadyExistsException
- cookbookId
is
already in hierarchyNotFoundException
- cookbookId
is not
foundNullArgumentException
- cookbookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootCookbook(Id cookbookId) throws NotFoundException, OperationFailedException, PermissionDeniedException
cookbookId
- the Id
of a cookbookNotFoundException
- cookbookId
is not a
rootNullArgumentException
- cookbookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildCookbook(Id cookbookId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
cookbookId
- the Id
of a cookbookchildId
- the Id
of the new childAlreadyExistsException
- cookbookId
is
already a parent of childId
NotFoundException
- cookbookId
or
childId
not foundNullArgumentException
- cookbookId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildCookbook(Id cookbookId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
cookbookId
- the Id
of a cookbookchildId
- the Id
of the new childNotFoundException
- cookbookId
not a
parent of childId
NullArgumentException
- cookbookId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildCookbooks(Id cookbookId) throws NotFoundException, OperationFailedException, PermissionDeniedException
cookbookId
- the Id
of a cookbookNotFoundException
- cookbookId
not foundNullArgumentException
- cookbookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.