Interface ForumManager

All Superinterfaces:

AutoCloseable, Closeable, ForumProfile, OsidManager, OsidManager, OsidProfile, Sourceable

public interface ForumManager
extends OsidManager, ForumProfile

The reply manager provides access to forum sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• PostLookupSession : a session to retrieve posts
• PostQuerySession : a session to query posts
• PostSearchSession : a session to search for posts
• PostAdminSession : a session to create, update and delete posts
• PostNotificationSession : a session to receive notifications for changes in posts
• PostForumSession : a session to lookup post forum mappings
• PostForumAssignmentSession : a session to manage post forum mappings
• PostSmartForumSession : a session to manage smart forums of posts

• ReplyLookupSession : a session to lookup replies
• ReplyAdminSession : a session to manage replies
• ReplyNotificationSession : a session to subscribe to notifications of reply changes

• ForumLookupSession : a session to retrieve forums
• ForumQuerySession : a session to query forums
• ForumSearchSession : a session to search for forums
• ForumAdminSession : a session to create, update and delete forums
• ForumNotificationSession : a session to receive notifications for changes in forums
• ForumHierarchySession : a session to traverse hierarchies of forums
• ForumHierarchyDesignSession : a session to manage hierarchies of forums

The forum manager also provides a profile for determing the supported search types supported by this service.

Method Summary

Modifier and Type	Method	Description
ForumAdminSession	getForumAdminSession()	Gets the OsidSession associated with the forum administrative service.
ForumBatchManager	getForumBatchManager()	Gets a ForumBatchManager .
ForumHierarchyDesignSession	getForumHierarchyDesignSession()	Gets the OsidSession associated with the forum hierarchy design service.
ForumHierarchySession	getForumHierarchySession()	Gets the OsidSession associated with the forum hierarchy service.
ForumLookupSession	getForumLookupSession()	Gets the OsidSession associated with the forum lookup service.
ForumNotificationSession	getForumNotificationSession(ForumReceiver forumReceiver)	Gets the OsidSession associated with the forum notification service.
ForumQuerySession	getForumQuerySession()	Gets the OsidSession associated with the forum query service.
ForumSearchSession	getForumSearchSession()	Gets the OsidSession associated with the forum search service.
PostAdminSession	getPostAdminSession()	Gets the OsidSession associated with the post administrative service.
PostAdminSession	getPostAdminSessionForForum(Id forumId)	Gets the OsidSession associated with the post administrative service for the given forum.
PostForumAssignmentSession	getPostForumAssignmentSession()	Gets the session for assigning post to forum mappings.
PostForumSession	getPostForumSession()	Gets the session for retrieving post to forum mappings.
PostLookupSession	getPostLookupSession()	Gets the OsidSession associated with the post lookup service.
PostLookupSession	getPostLookupSessionForForum(Id forumId)	Gets the OsidSession associated with the post lookup service for the given forum.
PostNotificationSession	getPostNotificationSession(PostReceiver postReceiver)	Gets the OsidSession associated with the post notification service.
PostNotificationSession	getPostNotificationSessionForForum(PostReceiver postReceiver, Id forumId)	Gets the OsidSession associated with the post notification service for the given forum.
PostQuerySession	getPostQuerySession()	Gets the OsidSession associated with the post query service.
PostQuerySession	getPostQuerySessionForForum(Id forumId)	Gets the OsidSession associated with the post query service for the given forum.
PostSearchSession	getPostSearchSession()	Gets the OsidSession associated with the post search service.
PostSearchSession	getPostSearchSessionForForum(Id forumId)	Gets the OsidSession associated with the post search service for the given forum.
PostSmartForumSession	getPostSmartForumSession(Id forumId)	Gets the session associated with the post smart forum for the given forum.
ReplyAdminSession	getReplyAdminSession()	Gets the OsidSession associated with the reply administration service.
ReplyAdminSession	getReplyAdminSessionForForum(Id forumId)	Gets the OsidSession associated with the reply administration service for the given forum.
ReplyLookupSession	getReplyLookupSession()	Gets the OsidSession associated with the reply lookup service.
ReplyLookupSession	getReplyLookupSessionForForum(Id forumId)	Gets the OsidSession associated with the reply lookup service for the given forum.
ReplyNotificationSession	getReplyNotificationSession(ReplyReceiver replyReceiver)	Gets the OsidSession associated with the reply notification service.
ReplyNotificationSession	getReplyNotificationSessionForForum(ReplyReceiver replyReceiver, Id forumId)	Gets the OsidSession associated with the reply notification service for the given forum.

Methods inherited from interface Closeable

close

Methods inherited from interface ForumProfile

getForumRecordTypes, getForumSearchRecordTypes, getPostRecordTypes, getPostSearchRecordTypes, getReplyRecordTypes, getReplySearchRecordTypes, supportsForumAdmin, supportsForumBatch, supportsForumHierarchy, supportsForumHierarchyDesign, supportsForumLookup, supportsForumNotification, supportsForumQuery, supportsForumRecordType, supportsForumSearch, supportsForumSearchRecordType, supportsPostAdmin, supportsPostForum, supportsPostForumAssignment, supportsPostLookup, supportsPostNotification, supportsPostQuery, supportsPostRecordType, supportsPostSearch, supportsPostSearchRecordType, supportsPostSmartForum, supportsReplyAdmin, supportsReplyLookup, supportsReplyNotification, supportsReplyRecordType, supportsReplySearchRecordType, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getForumRecordTypes()	Gets the supported Forum record types.
TypeList	getForumSearchRecordTypes()	Gets the supported forum search record types.
TypeList	getPostRecordTypes()	Gets the supported Post record types.
TypeList	getPostSearchRecordTypes()	Gets the supported post search record types.
TypeList	getReplyRecordTypes()	Gets the supported Reply record types.
TypeList	getReplySearchRecordTypes()	Gets the supported reply search record types.
boolean	supportsForumAdmin()	Tests for the availability of a forum administrative service for creating and deleting forums.
boolean	supportsForumBatch()	Tests if forum batch service is available.
boolean	supportsForumHierarchy()	Tests for the availability of a forum hierarchy traversal service.
boolean	supportsForumHierarchyDesign()	Tests for the availability of a forum hierarchy design service.
boolean	supportsForumLookup()	Tests for the availability of a forum lookup service.
boolean	supportsForumNotification()	Tests for the availability of a forum notification service.
boolean	supportsForumQuery()	Tests if querying forums is available.
boolean	supportsForumRecordType(Type forumRecordType)	Tests if the given Forum record type is supported.
boolean	supportsForumSearch()	Tests if searching for forums is available.
boolean	supportsForumSearchRecordType(Type forumSearchRecordType)	Tests if the given forum search record type is supported.
boolean	supportsPostAdmin()	Tests for the availability of a post administrative service for creating and deleting posts.
boolean	supportsPostForum()	Tests if a post to forum lookup session is available.
boolean	supportsPostForumAssignment()	Tests if a post to forum assignment session is available.
boolean	supportsPostLookup()	Tests for the availability of a post lookup service.
boolean	supportsPostNotification()	Tests for the availability of a post notification service.
boolean	supportsPostQuery()	Tests if querying posts is available.
boolean	supportsPostRecordType(Type postRecordType)	Tests if the given Post record type is supported.
boolean	supportsPostSearch()	Tests if searching for posts is available.
boolean	supportsPostSearchRecordType(Type postSearchRecordType)	Tests if the given post search record type is supported.
boolean	supportsPostSmartForum()	Tests if a post smart foruming session is available.
boolean	supportsReplyAdmin()	Tests if searching for replies is available.
boolean	supportsReplyLookup()	Tests for the availability of a reply lookup service.
boolean	supportsReplyNotification()	Tests if reply notification is available.
boolean	supportsReplyRecordType(Type replyRecordType)	Tests if the given Reply record type is supported.
boolean	supportsReplySearchRecordType(Type replySearchRecordType)	Tests if the given reply search record type is supported.
boolean	supportsVisibleFederation()	Tests if any post federation is exposed.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getPostLookupSession

PostLookupSession getPostLookupSession()
                                throws OperationFailedException

Gets the OsidSession associated with the post lookup service.

Returns:

a PostLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPostLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsPostLookup()} is {@code true} .

getPostLookupSessionForForum

PostLookupSession getPostLookupSessionForForum(Id forumId)
                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the post lookup service for the given forum.

Parameters:

forumId - the Id of the Post

Returns:

a PostLookupSession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - forumId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPostLookup()} and {@code supportsVisibleFederation()} are {@code true}

getPostQuerySession

PostQuerySession getPostQuerySession()
                              throws OperationFailedException

Gets the OsidSession associated with the post query service.

Returns:

a PostQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPostQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsPostQuery()} is {@code true} .

getPostQuerySessionForForum

PostQuerySession getPostQuerySessionForForum(Id forumId)
                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the post query service for the given forum.

Parameters:

forumId - the Id of the Post

Returns:

a PostQuerySession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - forumId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPostQuery()} and {@code supportsVisibleFederation()} are {@code true}

getPostSearchSession

PostSearchSession getPostSearchSession()
                                throws OperationFailedException

Gets the OsidSession associated with the post search service.

Returns:

a PostSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPostSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsPostSearch()} is {@code true} .

getPostSearchSessionForForum

PostSearchSession getPostSearchSessionForForum(Id forumId)
                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the post search service for the given forum.

Parameters:

forumId - the Id of the Post

Returns:

a PostSearchSession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - forumId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPostSearch()} and {@code supportsVisibleFederation()} are {@code true}

getPostAdminSession

PostAdminSession getPostAdminSession()
                              throws OperationFailedException

Gets the OsidSession associated with the post administrative service.

Returns:

a PostAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPostAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsPostAdmin()} is {@code true} .

getPostAdminSessionForForum

PostAdminSession getPostAdminSessionForForum(Id forumId)
                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the post administrative service for the given forum.

Parameters:

forumId - the Id of the Post

Returns:

a PostAdminSession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - forumId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPostAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getPostNotificationSession

PostNotificationSession getPostNotificationSession(PostReceiver postReceiver)
                                            throws OperationFailedException

Gets the OsidSession associated with the post notification service.

Parameters:

postReceiver - the receiver

Returns:

a PostNotificationSession

Throws:

NullArgumentException - postReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsPostNotification()} is {@code true} .

getPostNotificationSessionForForum

PostNotificationSession getPostNotificationSessionForForum(PostReceiver postReceiver,
 Id forumId)
                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the post notification service for the given forum.

Parameters:

postReceiver - the receiver

forumId - the Id of the Forum

Returns:

a PostNotificationSession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - postReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPostNotification()} and {@code supportsVisibleFederation()} are {@code true}

getPostForumSession

PostForumSession getPostForumSession()
                              throws OperationFailedException

Gets the session for retrieving post to forum mappings.

Returns:

a PostForumSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPostForum() is false

Compliance:

optional - This method must be implemented if {@code supportsPostForum()} is {@code true} .

getPostForumAssignmentSession

PostForumAssignmentSession getPostForumAssignmentSession()
                                                  throws OperationFailedException

Gets the session for assigning post to forum mappings.

Returns:

a PostForumAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPostForumAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsPostForumAssignment()} is {@code true} .

getPostSmartForumSession

PostSmartForumSession getPostSmartForumSession(Id forumId)
                                        throws NotFoundException,
OperationFailedException

Gets the session associated with the post smart forum for the given forum.

Parameters:

forumId - the Id of the forum

Returns:

a PostSmartForumSession

Throws:

NotFoundException - forumId not found

NullArgumentException - forumId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostSmartForum() is false

Compliance:

optional - This method must be implemented if {@code supportsPostSmartForum()} is {@code true} .

getReplyLookupSession

ReplyLookupSession getReplyLookupSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the reply lookup service.

Returns:

a ReplyLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsReplyLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsReplyLookup()} is {@code true} .

getReplyLookupSessionForForum

ReplyLookupSession getReplyLookupSessionForForum(Id forumId)
                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the reply lookup service for the given forum.

Parameters:

forumId - the Id of the Forum

Returns:

a ReplyLookupSession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - forumId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsReplyLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsReplyLookup()} and {@code supportsVisibleFederation()} are {@code true}

getReplyAdminSession

ReplyAdminSession getReplyAdminSession()
                                throws OperationFailedException

Gets the OsidSession associated with the reply administration service.

Returns:

a ReplyAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsReplyAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsReplyAdmin()} is {@code true} .

getReplyAdminSessionForForum

ReplyAdminSession getReplyAdminSessionForForum(Id forumId)
                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the reply administration service for the given forum.

Parameters:

forumId - the Id of the Forum

Returns:

a ReplyAdminSession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - forumId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsReplyAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsReplyAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getReplyNotificationSession

ReplyNotificationSession getReplyNotificationSession(ReplyReceiver replyReceiver)
                                              throws OperationFailedException

Gets the OsidSession associated with the reply notification service.

Parameters:

replyReceiver - the receiver

Returns:

a ReplyNotificationSession

Throws:

NullArgumentException - replyReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsReplyNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsReplyNotification()} is {@code true} .

getReplyNotificationSessionForForum

ReplyNotificationSession getReplyNotificationSessionForForum(ReplyReceiver replyReceiver,
 Id forumId)
                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the reply notification service for the given forum.

Parameters:

replyReceiver - the receiver

forumId - the Id of the Forum

Returns:

a ReplyNotificationSession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - replyReceiver or forumId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsReplyNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsReplyNotification()} and {@code supportsVisibleFederation()} are {@code true}

getForumLookupSession

ForumLookupSession getForumLookupSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the forum lookup service.

Returns:

a ForumLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsForumLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsForumLookup()} is {@code true} .

getForumQuerySession

ForumQuerySession getForumQuerySession()
                                throws OperationFailedException

Gets the OsidSession associated with the forum query service.

Returns:

a ForumQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsForumQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsForumQuery()} is {@code true} .

getForumSearchSession

ForumSearchSession getForumSearchSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the forum search service.

Returns:

a ForumSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsForumSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsForumSearch()} is {@code true} .

getForumAdminSession

ForumAdminSession getForumAdminSession()
                                throws OperationFailedException

Gets the OsidSession associated with the forum administrative service.

Returns:

a ForumAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsForumAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsForumAdmin()} is {@code true} .

getForumNotificationSession

ForumNotificationSession getForumNotificationSession(ForumReceiver forumReceiver)
                                              throws OperationFailedException

Gets the OsidSession associated with the forum notification service.

Parameters:

forumReceiver - the receiver

Returns:

a ForumNotificationSession

Throws:

NullArgumentException - forumReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsForumNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsForumNotification()} is {@code true} .

getForumHierarchySession

ForumHierarchySession getForumHierarchySession()
                                        throws OperationFailedException

Gets the OsidSession associated with the forum hierarchy service.

Returns:

a ForumHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsForumHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsForumHierarchy()} is {@code true} .

getForumHierarchyDesignSession

ForumHierarchyDesignSession getForumHierarchyDesignSession()
                                                    throws OperationFailedException

Gets the OsidSession associated with the forum hierarchy design service.

Returns:

a ForumHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsForumHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsForumHierarchyDesign()} is {@code true} .

getForumBatchManager

ForumBatchManager getForumBatchManager()
                                throws OperationFailedException

Gets a ForumBatchManager .

Returns:

a ForumBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsForumBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsForumBatch()} is {@code true} .