public interface BookHierarchyDesignSession extends OsidSession
This session manages a hierarchy of books. Books may be organized into
a hierarchy for organizing or federating. A parent Book
includes all of the comments of its children such that a single root node
contains all of the comments of the federation.
Modifier and Type | Method and Description |
---|---|
void |
addChildBook(Id bookId,
Id childId)
Adds a child to a book.
|
void |
addRootBook(Id bookId)
Adds a root book.
|
boolean |
canModifyBookHierarchy()
Tests if this user can change the hierarchy.
|
Hierarchy |
getBookHierarchy()
Gets the hierarchy associated with this session.
|
Id |
getBookHierarchyId()
Gets the hierarchy
Id associated with this session. |
void |
removeChildBook(Id bookId,
Id childId)
Removes a child from a book.
|
void |
removeChildBooks(Id bookId)
Removes all children from a book.
|
void |
removeRootBook(Id bookId)
Removes a root book.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBookHierarchyId()
Id
associated with this session. Id
associated with this sessionmandatory
- This method must be implemented. Hierarchy getBookHierarchy() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canModifyBookHierarchy()
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 addRootBook(Id bookId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
bookId
- the Id
of a bookAlreadyExistsException
- bookId
is
already in hierarchyNotFoundException
- bookId
is not foundNullArgumentException
- bookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeRootBook(Id bookId) throws NotFoundException, OperationFailedException, PermissionDeniedException
bookId
- the Id
of a bookNotFoundException
- bookId
is not a rootNullArgumentException
- bookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void addChildBook(Id bookId, Id childId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
bookId
- the Id
of a bookchildId
- the Id
of the new childAlreadyExistsException
- bookId
is
already a parent of childId
NotFoundException
- bookId
or
childId
not foundNullArgumentException
- bookId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildBook(Id bookId, Id childId) throws NotFoundException, OperationFailedException, PermissionDeniedException
bookId
- the Id
of a bookchildId
- the Id
of the new childNotFoundException
- bookId
not a parent
of childId
NullArgumentException
- bookId
or
childId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void removeChildBooks(Id bookId) throws NotFoundException, OperationFailedException, PermissionDeniedException
bookId
- the Id
of a bookNotFoundException
- bookId
not foundNullArgumentException
- bookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.