Package org.osid.forum

package org.osid.forum

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

The Forum OSID defines threaded diiscussion groups managing a set of posts and replies.

Posts

A Post is an OsidObject that defines some text, a timestamp, and a poster.

Replies

A Reply is similar to a Post but is in response to either a Post or another Reply . A Reply is a Containable making directly accessible any nested Replies outside of the session.

Posters

An Agent posts to a Forum or an Agent replies to a Post . The relationship between the Agent and its associated Resource is orchestrated within the Forum OSID. Posts and Replies reveal both the posting Agent and the associated poster Resource .

Forum Catalogs

Forums represent collections of Posts . Forums may be created through federation or by selecting Posts based on their attributes to create a virtual catalog of Posts. Replies are always associated with their Posts and may not be cataloged independently.

Sub Packages

The Forum OSID contains a Forum Batch OSID for managing Posts and Replies in bulk.

Copyright © 2010 Ingenescus. All Rights Reserved.

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.

Related Packages

Package	Description
org.osid	The Open Service Interface Definitions for the org.osid service.
org.osid.forum.batch	The Open Service Interface Definitions for the org.osid.forum.batch service.
org.osid.forum.records

Interfaces

Class	Description
Forum	A Forum represents a collection of posts and replies.
ForumAdminSession	This session creates, updates, and deletes Forums .
ForumForm	This is the form for creating and updating Forums .
ForumHierarchyDesignSession	This session manages a hierarchy of forums.
ForumHierarchySession	This session defines methods for traversing a hierarchy of Forums .
ForumList	Like all OsidLists , ForumList provides a means for accessing Forum elements sequentially either one at a time or many at a time.
ForumLookupSession	This session provides methods for retrieving Forums .
ForumManager	The reply manager provides access to forum sessions and provides interoperability tests for various aspects of this service.
ForumNode	This interface is a container for a partial hierarchy retrieval.
ForumNodeList	Like all OsidLists , ForumNodeList provides a means for accessing ForumNode elements sequentially either one at a time or many at a time.
ForumNotificationSession	This session defines methods to receive notifications on adds/changes to Forums .
ForumProfile	The reply profile describes the interoperability among forum services.
ForumProxyManager	The reply manager provides access to forum sessions and provides interoperability tests for various aspects of this service.
ForumQuery	This is the query for searching for forums.
ForumQueryInspector	This is the query inspector for examining forum queries.
ForumQuerySession	This session provides methods for searching Forums .
ForumReceiver	The forum receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Forum objects.
ForumSearch	The search interface for governing forum searches.
ForumSearchOrder	An interface for specifying the ordering of search results.
ForumSearchResults	This interface provides a means to capture results of a search.
ForumSearchSession	This session provides methods for searching Forums .
Post	A Post represents a blob of text posted to a forum by a poster.
PostAdminSession	This session creates, updates, and deletes Posts .
PostForm	This is the form for creating and updating Posts .
PostForumAssignmentSession	This session provides methods to re-assign Posts to Forums .
PostForumSession	This session provides methods to retrieve Post to Forum mappings.
PostList	Like all OsidLists , PostList provides a means for accessing Post elements sequentially either one at a time or many at a time.
PostLookupSession	This session provides methods for retrieving Posts .
PostNotificationSession	This session defines methods to receive notifications on adds/changes to Posts .
PostQuery	This is the query for searching for posts.
PostQueryInspector	This is the query inspector for examining for post queries.
PostQuerySession	This session provides methods for searching Posts .
PostReceiver	The post receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Post objects.
PostSearch	The search interface for governing post searches.
PostSearchOrder	An interface for specifying the ordering of search results.
PostSearchResults	This interface provides a means to capture results of a search.
PostSearchSession	This session provides methods for searching Posts .
PostSmartForumSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Reply	A Reply is a response to a Post or another Reply .
ReplyAdminSession	This session creates, updates, and deletes Replies .
ReplyForm	This is the form for creating and updating Reply objects.
ReplyList	Like all OsidLists , ReplyList provides a means for accessing Reply elements sequentially either one at a time or many at a time.
ReplyLookupSession	This session defines methods for retrieving replies.
ReplyNotificationSession	This session defines methods to receive notifications on adds/changes to Reply objects.
ReplyQuery	This is the query for searching for replies.
ReplyQueryInspector	This is the query inspector for examining reply queries.
ReplyReceiver	The reply receiver is the consumer supplied interface for receiving notifications pertaining to new or deleted replies.
ReplySearch	The search interface for governing reply searches.
ReplySearchOrder	An interface for specifying the ordering of search results.
ReplySearchResults	This interface provides a means to capture results of a search.