org.osid.commenting

Interface Summary
Interface	Description
Book	A `Book` represents a collection of comments.
BookAdminSession	This session creates, updates, and deletes `Books.`
BookForm	This is the form for creating and updating `Books.`
BookHierarchyDesignSession	This session manages a hierarchy of books.
BookHierarchySession	This session defines methods for traversing a hierarchy of `Book` objects.
BookList	Like all `OsidLists,` `BookList` provides a means for accessing `Book` elements sequentially either one at a time or many at a time.
BookLookupSession	This session provides methods for retrieving `Book` objects.
BookNode	This interface is a container for a partial hierarchy retrieval.
BookNodeList	Like all `OsidLists,` `BookNodeList` provides a means for accessing `BookNode` elements sequentially either one at a time or many at a time.
BookNotificationSession	This session defines methods to receive notifications on adds/changes to `Book` objects.
BookQuery	This is the query for searching books.
BookQueryInspector	This is the query inspector for examining bok queries.
BookQuerySession	This session provides methods for searching `Book` objects.
BookReceiver	The book receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Book` objects.
BookSearch	The search interface for governing book searches.
BookSearchOrder	An interface for specifying the ordering of search results.
BookSearchResults	This interface provides a means to capture results of a search.
BookSearchSession	This session provides methods for searching `Book` objects.
Comment	A `Comment` represents a comment and/or rating related to a reference object in a book.
CommentAdminSession	This session creates, updates, and deletes `Comments.`
CommentBookAssignmentSession	This session provides methods to re-assign `Comments` to `Books.`
CommentBookSession	This session provides methods to retrieve `Comment` to `Book` mappings.
CommentForm	This is the form for creating and updating `Comment` objects.
CommentingManager	The commenting manager provides access to commenting sessions and provides interoperability tests for various aspects of this service.
CommentingProfile	The commenting profile describes the interoperability among commenting services.
CommentingProxyManager	The commenting manager provides access to commenting sessions and provides interoperability tests for various aspects of this service.
CommentList	Like all `OsidLists,` `CommentList` provides a means for accessing `Comment` elements sequentially either one at a time or many at a time.
CommentLookupSession	This session defines methods for retrieving comments.
CommentNotificationSession	This session defines methods to receive notifications on adds/changes to `Comment` objects.
CommentQuery	This is the query for searching comments.
CommentQueryInspector	The comment query inspector for examining comment queries.
CommentQuerySession	This session provides methods for searching `Comment` objects.
CommentReceiver	The comment receiver is the consumer supplied interface for receiving notifications pertaining to new or deleted comments.
CommentSearch	The search interface for governing comment searches.
CommentSearchOrder	An interface for specifying the ordering of search results.
CommentSearchResults	This interface provides a means to capture results of a search.
CommentSearchSession	This session provides methods for searching `Comment` objects.
CommentSmartBookSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
RatingLookupSession	This session defines methods for retrieving comments.

Package org.osid.commenting Description

The Open Service Interface Definitions for the org.osid.commenting service.

The Commenting OSID provides a means of relating user comments and ratings to OSID Objects.

The Commenting OSID may be used as an auxiliary service orchestrated with other OSIDs to either provide administrative comments as well as create a social network-esque comment and rating service to various OsidObjects.

Comments

Comments contain text entries logged by date and Agent. A Comment may also include a rating represented by a Grade defined in a GradeSystem. The RatingLookupSession may be used to query cumulative scores across an object reference or the entire Book.

Comments are OsidRelationships between a commentor and a reference Id. The relationship defines dates for which the comment and/or rating is effective.

Commentors

An Agent comments on something. As a person is represented by a Resource in the Resource OSID, the Comments provide access to both the commenting Agent and the related Resource to avoid the need of an additional service orchestration for resolving the Agent.

Cataloging

Comments are cataloged in Books which may also be grouped hierarchically to federate multiple collections of comments.

Sub Packages

The Commenting OSID includes a Commenting Batch OSID for managing Comments and Books in bulk.

This Work is being provided by the copyright holder(s) subject to the following license. By obtaining, using and/or copying this Work, you agree that you have read, understand, and will comply with the following terms and conditions.

Permission to use, copy and distribute unmodified versions of this Work, for any purpose, without fee or royalty is hereby granted, provided that you include the above copyright notices and the terms of this license on ALL copies of the Work or portions thereof.

You may nodify or create Derivatives of this Work only for your internal purposes. You shall not distribute or transfer any such Derivative of this Work to any location or to any third party. For the purposes of this license, "Derivative" shall mean any derivative of the Work as defined in the United States Copyright Act of 1976, such as a translation or modification.

This Work and the information contained herein is provided on an "AS IS" basis WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS IN THE WORK.

The export of software employing encryption technology may require a specific license from the United States Government. It is the responsibility of any person or organization contemplating export to obtain such a license before exporting this Work.