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

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.

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.
MethodcanModifyBookHierarchy
Description

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.

Returnboolean false if changing this hierarchy is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaddRootBook
Description

Adds a root book.

Parametersosid.id.IdbookIdthe Id of a book
ErrorsALREADY_EXISTS bookId is already in hierarchy
NOT_FOUND bookId is not found
NULL_ARGUMENT bookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootBook
Description

Removes a root book.

Parametersosid.id.IdbookIdthe Id of a book
ErrorsNOT_FOUND bookId is not a root
NULL_ARGUMENT bookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildBook
Description

Adds a child to a book.

Parametersosid.id.IdbookIdthe Id of a book
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS bookId is already a parent of childId
NOT_FOUND bookId or childId not found
NULL_ARGUMENT bookId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildBook
Description

Removes a child from a book.

Parametersosid.id.IdbookIdthe Id of a book
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND bookId not a parent of childId
NULL_ARGUMENT bookId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildBooks
Description

Removes all children from a book.

Parametersosid.id.IdbookIdthe Id of a book
ErrorsNOT_FOUND bookId not found
NULL_ARGUMENT bookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.