Interface ForumBatchManager
- All Superinterfaces:
AutoCloseable, Closeable, ForumBatchProfile, OsidManager, OsidManager, OsidProfile, Sourceable
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 TypeMethodDescriptionGets theOsidSessionassociated with the bulk forum administration service.Gets theOsidSessionassociated with the bulk post administration service.getPostBatchAdminSessionForForum(Id forumId) Gets theOsidSessionassociated with the bulk post administration service for the given forum.Gets theOsidSessionassociated with the bulk reply administration service.getReplyBatchAdminSessionForForum(Id forumId) Gets theOsidSessionassociated with the bulk reply administration service for the given forum.Methods inherited from interface ForumBatchProfile
supportsForumBatchAdmin, supportsPostBatchAdmin, supportsReplyBatchAdmin, supportsVisibleFederationModifier and TypeMethodDescriptionbooleanTests if bulk administration of forums is available.booleanTests if bulk administration of posts is available.booleanTests if bulk administration of replies is available.booleanTests if federation is visible.Methods inherited from interface OsidManager
closeMethods inherited from interface OsidManager
changeBranch, initialize, rollbackServiceModifier and TypeMethodDescriptionvoidchangeBranch(Id branchId) Changes the service branch.voidinitialize(OsidRuntimeManager runtime) Initializes this manager.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, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
getPostBatchAdminSession
Gets theOsidSessionassociated with the bulk post administration service.- Returns:
- a
PostBatchAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsPostBatchAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostBatchAdmin()} is {@code true} .
-
getPostBatchAdminSessionForForum
PostBatchAdminSession getPostBatchAdminSessionForForum(Id forumId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the bulk post administration service for the given forum.- Parameters:
forumId- theIdof theForum- Returns:
- a
PostBatchAdminSession - Throws:
NotFoundException- noForumfound by the givenIdNullArgumentException-forumIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPostBatchAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPostBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getReplyBatchAdminSession
Gets theOsidSessionassociated with the bulk reply administration service.- Returns:
- a
ReplyBatchAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsReplyBatchAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsReplyBatchAdmin()} is {@code true} .
-
getReplyBatchAdminSessionForForum
ReplyBatchAdminSession getReplyBatchAdminSessionForForum(Id forumId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the bulk reply administration service for the given forum.- Parameters:
forumId- theIdof theForum- Returns:
- a
ReplyBatchAdminSession - Throws:
NotFoundException- noForumfound by the givenIdNullArgumentException-forumIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsReplyBatchAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsReplyBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getForumBatchAdminSession
Gets theOsidSessionassociated with the bulk forum administration service.- Returns:
- a
ForumBatchAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsForumBatchAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsForumBatchAdmin()} is {@code true} .
-