Interface ForumBatchManager

All Superinterfaces:

AutoCloseable, Closeable, ForumBatchProfile, OsidManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface ForumBatchProfile

supportsForumBatchAdmin, supportsPostBatchAdmin, supportsReplyBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsForumBatchAdmin()	Tests if bulk administration of forums is available.
boolean	supportsPostBatchAdmin()	Tests if bulk administration of posts is available.
boolean	supportsReplyBatchAdmin()	Tests if bulk administration of replies is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

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

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 {@code supportsPostBatchAdmin()} is {@code 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 {@code supportsPostBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsReplyBatchAdmin()} is {@code 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 {@code supportsReplyBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsForumBatchAdmin()} is {@code true} .