org.osid.forum.batch

Interface ForumBatchManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, ForumBatchProfile, OsidManager, OsidProfile, Sourceable

public interface ForumBatchManager
extends OsidManager, ForumBatchProfile

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

• PostBatchSession: a session to create, modify and delete posts in bulk
• ReplyBatchAdminSession: a session to create, modify and delete replies in bulk
• ForumBatchAdminSession: a session to create, modify and delete forums in bulk

Method Summary

Methods

Modifier and Type	Method and Description
ForumBatchAdminSession	getForumBatchAdminSession() Gets the OsidSession associated with the bulk forum administration service.
PostBatchAdminSession	getPostBatchAdminSession() Gets the OsidSession associated with the bulk post administration service.
PostBatchAdminSession	getPostBatchAdminSessionForForum(Id forumId) Gets the OsidSession associated with the bulk post administration service for the given forum.
ReplyBatchAdminSession	getReplyBatchAdminSession() Gets the OsidSession associated with the bulk reply administration service.
ReplyBatchAdminSession	getReplyBatchAdminSessionForForum(Id forumId) Gets the OsidSession associated with the bulk reply administration service for the given forum.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.forum.batch.ForumBatchProfile

supportsForumBatchAdmin, supportsPostBatchAdmin, supportsReplyBatchAdmin, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getPostBatchAdminSession

PostBatchAdminSession getPostBatchAdminSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk post administration service.

Returns:

a PostBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPostBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsPostBatchAdmin() is true.

getPostBatchAdminSessionForForum

PostBatchAdminSession getPostBatchAdminSessionForForum(Id forumId)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession associated with the bulk post administration service for the given forum.

Parameters:

forumId - the Id of the Forum

Returns:

a PostBatchAdminSession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - forumId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPostBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPostBatchAdmin() and supportsVisibleFederation() are true

getReplyBatchAdminSession

ReplyBatchAdminSession getReplyBatchAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk reply administration service.

Returns:

a ReplyBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsReplyBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsReplyBatchAdmin() is true.

getReplyBatchAdminSessionForForum

ReplyBatchAdminSession getReplyBatchAdminSessionForForum(Id forumId)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

forumId - the Id of the Forum

Returns:

a ReplyBatchAdminSession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - forumId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsReplyBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsReplyBatchAdmin() and supportsVisibleFederation() are true

getForumBatchAdminSession

ForumBatchAdminSession getForumBatchAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk forum administration service.

Returns:

a ForumBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsForumBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsForumBatchAdmin() is true.