Interface BookHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

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.

Method Summary

Modifier and Type	Method	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.

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

getBookHierarchyId

Id getBookHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBookHierarchy

Hierarchy getBookHierarchy()
                    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.

canModifyBookHierarchy

boolean canModifyBookHierarchy()

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.

addRootBook

void addRootBook(Id bookId)
          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root book.

Parameters:

bookId - the Id of a book

Throws:

AlreadyExistsException - bookId is already in hierarchy

NotFoundException - bookId is not found

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootBook

void removeRootBook(Id bookId)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a root book.

Parameters:

bookId - the Id of a book

Throws:

NotFoundException - bookId is not a root

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildBook

void addChildBook(Id bookId,
 Id childId)
           throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a book.

Parameters:

bookId - the Id of a book

childId - the Id of the new child

Throws:

AlreadyExistsException - bookId is already a parent of childId

NotFoundException - bookId or childId not found

NullArgumentException - bookId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildBook

void removeChildBook(Id bookId,
 Id childId)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a book.

Parameters:

bookId - the Id of a book

childId - the Id of the new child

Throws:

NotFoundException - bookId not a parent of childId

NullArgumentException - bookId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildBooks

void removeChildBooks(Id bookId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a book.

Parameters:

bookId - the Id of a book

Throws:

NotFoundException - bookId not found

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.