org.osid.forum.batch

Interface ForumBatchProxyManager

All Superinterfaces:

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

public interface ForumBatchProxyManager
extends OsidProxyManager, ForumBatchProfile

The forum batch proxy manager provides access to forum batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. 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(Proxy proxy) Gets the OsidSession associated with the bulk forum administration service.
PostBatchAdminSession	getPostBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk post administration service.
PostBatchAdminSession	getPostBatchAdminSessionForForum(Id forumId, Proxy proxy) Gets the OsidSession associated with the bulk post administration service for the given forum.
ReplyBatchAdminSession	getReplyBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk reply administration service.
ReplyBatchAdminSession	getReplyBatchAdminSessionForForum(Id forumId, Proxy proxy) Gets the OsidSession associated with the bulk reply administration service for the given forum.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk post administration service.

Parameters:

proxy - a proxy

Returns:

a PostBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

forumId - the Id of the Forum

proxy - a proxy

Returns:

a PostBatchAdminSession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - forumId or proxy 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(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk reply administration service.

Parameters:

proxy - a proxy

Returns:

a ReplyBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

forumId - the Id of the Forum

proxy - a proxy

Returns:

a ReplyBatchAdminSession

Throws:

NotFoundException - no Forum found by the given Id

NullArgumentException - forumId or proxy 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(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk forum administration service.

Parameters:

proxy - a proxy

Returns:

a ForumBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsForumBatchAdmin() is false

Compliance:

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