OSID Logo
OSID Specifications
commenting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.commenting.BookHierarchySession
Implementsosid.OsidSession
Description

This session defines methods for traversing a hierarchy of Book objects. 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
MethodgetBookHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBookHierarchy
Description

Gets the hierarchy associated with this session.

Returnosid.hierarchy.Hierarchythe hierarchy associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAccessBookHierarchy
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.

Returnboolean false if hierarchy traversal methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeBookView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryBookView
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.

CompliancemandatoryThis method is must be implemented.
MethodgetRootBookIds
Description

Gets the root book Ids in this hierarchy.

Returnosid.id.IdListthe root book Ids
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRootBooks
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.

Returnosid.commenting.BookListthe root books
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodhasParentBooks
Description

Tests if the Book has any parents.

Parametersosid.id.IdbookIda book Id
Returnboolean true if the book has parents, f alse otherwise
ErrorsNOT_FOUND bookId is not found
NULL_ARGUMENT bookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisParentOfBook
Description

Tests if an Id is a direct parent of book.

Parametersosid.id.Ididan Id
osid.id.IdbookIdthe Id of a book
Returnboolean true if this id is a parent of bookId, f alse otherwise
ErrorsNOT_FOUND bookId is not found
NULL_ARGUMENT id or bookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetParentBookIds
Description

Gets the parent Ids of the given book.

Parametersosid.id.IdbookIda book Id
Returnosid.id.IdListthe parent Ids of the book
ErrorsNOT_FOUND bookId is not found
NULL_ARGUMENT bookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParentBooks
Description

Gets the parent books of the given id.

Parametersosid.id.IdbookIdthe Id of the Book to query
Returnosid.commenting.BookListthe parent books of the id
ErrorsNOT_FOUNDa Book identified by Id is not found
NULL_ARGUMENT bookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisAncestorOfBook
Description

Tests if an Id is an ancestor of a book.

Parametersosid.id.Ididan Id
osid.id.IdbookIdthe Id of a book
Returnboolean tru e if this id is an ancestor of bookId, false otherwise
ErrorsNOT_FOUND bookId is not found
NULL_ARGUMENT id or bookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodhasChildBooks
Description

Tests if a book has any children.

Parametersosid.id.IdbookIda book Id
Returnboolean true if the bookId has children, false otherwise
ErrorsNOT_FOUND bookId is not found
NULL_ARGUMENT bookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisChildOfBook
Description

Tests if a book is a direct child of another.

Parametersosid.id.Ididan Id
osid.id.IdbookIdthe Id of a book
Returnboolean true if the id is a child of bookId, false otherwise
ErrorsNOT_FOUND bookId is not found
NULL_ARGUMENT id or bookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetChildBookIds
Description

Gets the child Ids of the given book.

Parametersosid.id.IdbookIdthe Id to query
Returnosid.id.IdListthe children of the book
ErrorsNOT_FOUND bookId is not found
NULL_ARGUMENT bookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChildBooks
Description

Gets the child books of the given id.

Parametersosid.id.IdbookIdthe Id of the Book to query
Returnosid.commenting.BookListthe child books of the id
ErrorsNOT_FOUNDa Book identified by Id is not found
NULL_ARGUMENT bookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisDescendantOfBook
Description

Tests if an Id is a descendant of a book.

Parametersosid.id.Ididan Id
osid.id.IdbookIdthe Id of a book
Returnboolean true if the id is a descendant of the bookId, false otherwise
ErrorsNOT_FOUND bookId is not found
NULL_ARGUMENT id or bookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id is not found return false.

MethodgetBookNodeIds
Description

Gets a portion of the hierarchy for the given book.

Parametersosid.id.IdbookIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.hierarchy.Nodea book node
ErrorsNOT_FOUND bookId is not found
NULL_ARGUMENT bookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBookNodes
Description

Gets a portion of the hierarchy for the given book.

Parametersosid.id.IdbookIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.commenting.BookNodea book node
ErrorsNOT_FOUND bookId is not found
NULL_ARGUMENT bookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.