OSID - osid.commenting.BookHierarchySession Service Interface Definition

Interface	osid.commenting.BookHierarchySession
Implements	`osid.OsidSession`
Used By	`osid.commenting.CommentingManager`
Used By	`osid.commenting.CommentingProxyManager`
Description	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	getBookHierarchyId
Description	Gets the hierarchy `Id` associated with this session.
Return	`osid.id.Id`		the hierarchy `Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBookHierarchy
Description	Gets the hierarchy associated with this session.
Return	`osid.hierarchy.Hierarchy`		the hierarchy associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAccessBookHierarchy
Description	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.
Return	`boolean`		`false` if hierarchy traversal methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeBookView
Description	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.
Method	usePlenaryBookView
Description	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.
Method	getRootBookIds
Description	Gets the root book `Ids` in this hierarchy.
Return	`osid.id.IdList`		the root book `Ids`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRootBooks
Description	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.
Return	`osid.commenting.BookList`		the root books
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	hasParentBooks
Description	Tests if the `Book` has any parents.
Parameters	`osid.id.Id`	`bookId`	a book `Id`
Return	`boolean`		`true` if the book has parents, f `alse` otherwise
Errors	NOT_FOUND		`bookId` is not found
	NULL_ARGUMENT		`bookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isParentOfBook
Description	Tests if an `Id` is a direct parent of book.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`bookId`	the `Id` of a book
Return	`boolean`		`true` if this `id` is a parent of `bookId`, f `alse` otherwise
Errors	NOT_FOUND		`bookId` is not found
	NULL_ARGUMENT		`id` or `bookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false`.
Method	getParentBookIds
Description	Gets the parent `Ids` of the given book.
Parameters	`osid.id.Id`	`bookId`	a book `Id`
Return	`osid.id.IdList`		the parent `Ids` of the book
Errors	NOT_FOUND		`bookId` is not found
	NULL_ARGUMENT		`bookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParentBooks
Description	Gets the parent books of the given `id`.
Parameters	`osid.id.Id`	`bookId`	the `Id` of the `Book` to query
Return	`osid.commenting.BookList`		the parent books of the `id`
Errors	NOT_FOUND		a `Book` identified by `Id is` not found
	NULL_ARGUMENT		`bookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isAncestorOfBook
Description	Tests if an `Id` is an ancestor of a book.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`bookId`	the `Id` of a book
Return	`boolean`		`true` if this `id` is an ancestor of `bookId`, `false` otherwise
Errors	NOT_FOUND		`bookId` is not found
	NULL_ARGUMENT		`id` or `bookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false`.
Method	hasChildBooks
Description	Tests if a book has any children.
Parameters	`osid.id.Id`	`bookId`	a book `Id`
Return	`boolean`		`true` if the `bookId` has children, `false` otherwise
Errors	NOT_FOUND		`bookId` is not found
	NULL_ARGUMENT		`bookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isChildOfBook
Description	Tests if a book is a direct child of another.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`bookId`	the `Id` of a book
Return	`boolean`		`true` if the `id` is a child of `bookId` , `false` otherwise
Errors	NOT_FOUND		`bookId` is not found
	NULL_ARGUMENT		`id` or `bookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` not found return `false`.
Method	getChildBookIds
Description	Gets the child `Ids` of the given book.
Parameters	`osid.id.Id`	`bookId`	the `Id` to query
Return	`osid.id.IdList`		the children of the book
Errors	NOT_FOUND		`bookId` is not found
	NULL_ARGUMENT		`bookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getChildBooks
Description	Gets the child books of the given `id`.
Parameters	`osid.id.Id`	`bookId`	the `Id` of the `Book` to query
Return	`osid.commenting.BookList`		the child books of the `id`
Errors	NOT_FOUND		a `Book` identified by `Id is` not found
	NULL_ARGUMENT		`bookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	isDescendantOfBook
Description	Tests if an `Id` is a descendant of a book.
Parameters	`osid.id.Id`	`id`	an `Id`
Parameters	`osid.id.Id`	`bookId`	the `Id` of a book
Return	`boolean`		`true` if the `id` is a descendant of the `bookId`, `false` otherwise
Errors	NOT_FOUND		`bookId` is not found
	NULL_ARGUMENT		`id` or `bookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If `id` is not found return `false`.
Method	getBookNodeIds
Description	Gets a portion of the hierarchy for the given book.
Parameters	`osid.id.Id`	`bookId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the node.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given node, `false` to omit the siblings
Return	`osid.hierarchy.Node`		a book node
Errors	NOT_FOUND		`bookId` is not found
	NULL_ARGUMENT		`bookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBookNodes
Description	Gets a portion of the hierarchy for the given book.
Parameters	`osid.id.Id`	`bookId`	the `Id` to query
	`cardinal`	`ancestorLevels`	the maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
	`cardinal`	`descendantLevels`	the maximum number of descendant levels to include. A value of 0 returns no children in the node.
	`boolean`	`includeSiblings`	`true` to include the siblings of the given node, `false` to omit the siblings
Return	`osid.commenting.BookNode`		a book node
Errors	NOT_FOUND		`bookId` is not found
	NULL_ARGUMENT		`bookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.