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

This session manages queries and sequencing to create "smart" dynamic catalogs. A CommentQuery can be retrieved from this session and mapped to this Book to create a virtual collection of Comments. The comments may be sequenced using the CommentSearchOrder from this session.

This Book has a default query that matches any comment and a default search order that specifies no sequencing. The queries may be examined using a CommentQueryInspector. The query may be modified by converting the inspector back to a CommentQuery.

MethodgetBookId
Description

Gets the Book Id associated with this session.

Returnosid.id.Idthe Book Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBook
Description

Gets the Book associated with this session.

Returnosid.commenting.Bookthe Book associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartBooks
Description

Tests if this user can manage smart books. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returnboolean false if smart book management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCommentQuery
Description

Gets a comment query.

Returnosid.commenting.CommentQuerythe comment query
CompliancemandatoryThis method must be implemented.
MethodgetCommentSearchOrder
Description

Gets a comment search order.

Returnosid.commenting.CommentSearchOrderthe comment search order
CompliancemandatoryThis method must be implemented.
MethodapplyCommentQuery
Description

Applies a comment query to this book.

Parametersosid.commenting.CommentQuerycommentQuerythe comment query
ErrorsNULL_ARGUMENT commentQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED commentQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectCommentQuery
Description

Gets a comment query inspector for this book.

Returnosid.commenting.CommentQueryInspectorthe comment query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyCommentSequencing
Description

Applies a comment search order to this book.

Parametersosid.commenting.CommentSearchOrdercommentSearchOrderthe comment search order
ErrorsNULL_ARGUMENT commentSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED commentSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCommentQueryFromInspector
Description

Gets a comment query from an inspector.

Parametersosid.commenting.CommentQueryInspectorcommentQueryInspectora query inspector
Returnosid.commenting.CommentQuerythe comment query
ErrorsNULL_ARGUMENT commentQueryInspector is null
UNSUPPORTED commentQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.