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 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. |
changeBranch, initialize, rollbackService
close
supportsForumBatchAdmin, supportsPostBatchAdmin, supportsReplyBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
PostBatchAdminSession getPostBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk post
administration service.proxy
- a proxy PostBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPostBatchAdmin()
is false
optional
- This method must be implemented if
supportsPostBatchAdmin()
is true.
PostBatchAdminSession getPostBatchAdminSessionForForum(Id forumId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk post
administration service for the given forum.forumId
- the Id
of the Forum
proxy
- a proxy PostBatchAdminSession
NotFoundException
- no Forum
found by
the given Id
NullArgumentException
- forumId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPostBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPostBatchAdmin()
and
supportsVisibleFederation()
are true
ReplyBatchAdminSession getReplyBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk reply
administration service.proxy
- a proxy ReplyBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsReplyBatchAdmin()
is false
optional
- This method must be implemented if
supportsReplyBatchAdmin()
is true.
ReplyBatchAdminSession getReplyBatchAdminSessionForForum(Id forumId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk reply
administration service for the given forum.forumId
- the Id
of the Forum
proxy
- a proxy ReplyBatchAdminSession
NotFoundException
- no Forum
found by
the given Id
NullArgumentException
- forumId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsReplyBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsReplyBatchAdmin()
and
supportsVisibleFederation()
are true
ForumBatchAdminSession getForumBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk forum
administration service.proxy
- a proxy ForumBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsForumBatchAdmin()
is false
optional
- This method must be implemented if
supportsForumBatchAdmin()
is true.