Interface BookHierarchySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface BookHierarchySession
extends OsidSession

This session defines methods for traversing a hierarchy of Books . Each node in the hierarchy is a unique Book . The hierarchy may be traversed recursively to establish the tree structure through getParentBooks() and getChildBooks() . To relate these Ids to another OSID, getBookNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Book available in the Commenting OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root node or a child of another node.

A user may not be authorized to traverse the entire hierarchy. Parts of the hierarchy may be made invisible through omission from the returns of getParentBooks() or getChildBooks() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized pathways.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: book elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canAccessBookHierarchy()	Tests if this user can perform hierarchy queries.
Hierarchy	getBookHierarchy()	Gets the hierarchy associated with this session.
Id	getBookHierarchyId()	Gets the hierarchy Id associated with this session.
Node	getBookNodeIds(Id bookId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given book.
BookNode	getBookNodes(Id bookId, long ancestorLevels, long descendantLevels, boolean includeSiblings)	Gets a portion of the hierarchy for the given book.
IdList	getChildBookIds(Id bookId)	Gets the child Ids of the given book.
BookList	getChildBooks(Id bookId)	Gets the child books of the given id .
IdList	getParentBookIds(Id bookId)	Gets the parent Ids of the given book.
BookList	getParentBooks(Id bookId)	Gets the parent books of the given id .
IdList	getRootBookIds()	Gets the root book Ids in this hierarchy.
BookList	getRootBooks()	Gets the root books in the book hierarchy.
boolean	hasChildBooks(Id bookId)	Tests if a book has any children.
boolean	hasParentBooks(Id bookId)	Tests if the Book has any parents.
boolean	isAncestorOfBook(Id id, Id bookId)	Tests if an Id is an ancestor of a book.
boolean	isChildOfBook(Id id, Id bookId)	Tests if a book is a direct child of another.
boolean	isDescendantOfBook(Id id, Id bookId)	Tests if an Id is a descendant of a book.
boolean	isParentOfBook(Id id, Id bookId)	Tests if an Id is a direct parent of book.
void	useComparativeBookView()	The returns from the book methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryBookView()	A complete view of the Book returns is desired.

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.

canAccessBookHierarchy

boolean canAccessBookHierarchy()

Tests if this user can perform hierarchy queries. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup operations.

Returns:

false if hierarchy traversal methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeBookView

void useComparativeBookView()

The returns from the book methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryBookView

void usePlenaryBookView()

A complete view of the Book returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getRootBookIds

IdList getRootBookIds()
               throws OperationFailedException,
PermissionDeniedException

Gets the root book Ids in this hierarchy.

Returns:

the root book Ids

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRootBooks

BookList getRootBooks()
               throws OperationFailedException,
PermissionDeniedException

Gets the root books in the book hierarchy. A node with no parents is an orphan. While all book Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.

Returns:

the root books

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

hasParentBooks

boolean hasParentBooks(Id bookId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if the Book has any parents.

Parameters:

bookId - a book Id

Returns:

true if the book has parents, f alse otherwise

Throws:

NotFoundException - bookId is not found

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isParentOfBook

boolean isParentOfBook(Id id,
 Id bookId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a direct parent of book.

Parameters:

id - an Id

bookId - the Id of a book

Returns:

true if this id is a parent of bookId , f alse otherwise

Throws:

NotFoundException - bookId is not found

NullArgumentException - id or bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getParentBookIds

IdList getParentBookIds(Id bookId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent Ids of the given book.

Parameters:

bookId - a book Id

Returns:

the parent Ids of the book

Throws:

NotFoundException - bookId is not found

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParentBooks

BookList getParentBooks(Id bookId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the parent books of the given id .

Parameters:

bookId - the Id of the Book to query

Returns:

the parent books of the id

Throws:

NotFoundException - a Book identified by Id is not found

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isAncestorOfBook

boolean isAncestorOfBook(Id id,
 Id bookId)
                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is an ancestor of a book.

Parameters:

id - an Id

bookId - the Id of a book

Returns:

true if this id is an ancestor of bookId , false otherwise

Throws:

NotFoundException - bookId is not found

NullArgumentException - id or bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

hasChildBooks

boolean hasChildBooks(Id bookId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a book has any children.

Parameters:

bookId - a book Id

Returns:

true if the bookId has children, false otherwise

Throws:

NotFoundException - bookId is not found

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isChildOfBook

boolean isChildOfBook(Id id,
 Id bookId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if a book is a direct child of another.

Parameters:

id - an Id

bookId - the Id of a book

Returns:

true if the id is a child of bookId , false otherwise

Throws:

NotFoundException - bookId is not found

NullArgumentException - id or bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} not found return {@code false} .

getChildBookIds

IdList getChildBookIds(Id bookId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child Ids of the given book.

Parameters:

bookId - the Id to query

Returns:

the children of the book

Throws:

NotFoundException - bookId is not found

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getChildBooks

BookList getChildBooks(Id bookId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the child books of the given id .

Parameters:

bookId - the Id of the Book to query

Returns:

the child books of the id

Throws:

NotFoundException - a Book identified by Id is not found

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

isDescendantOfBook

boolean isDescendantOfBook(Id id,
 Id bookId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Tests if an Id is a descendant of a book.

Parameters:

id - an Id

bookId - the Id of a book

Returns:

true if the id is a descendant of the bookId , false otherwise

Throws:

NotFoundException - bookId is not found

NullArgumentException - id or bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

Notes:

If - {@code id} is not found return {@code false} .

getBookNodeIds

Node getBookNodeIds(Id bookId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given book.

Parameters:

bookId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a book node

Throws:

NotFoundException - bookId is not found

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBookNodes

BookNode getBookNodes(Id bookId,
 long ancestorLevels,
 long descendantLevels,
 boolean includeSiblings)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a portion of the hierarchy for the given book.

Parameters:

bookId - the Id to query

ancestorLevels - the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.

descendantLevels - the maximum number of descendant levels to include. A value of 0 returns no children in the node.

includeSiblings - true to include the siblings of the given node, false to omit the siblings

Returns:

a book node

Throws:

NotFoundException - bookId is not found

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.