org.osid.blogging.batch

Interface BloggingBatchManager

All Superinterfaces:

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

public interface BloggingBatchManager
extends OsidManager, BloggingBatchProfile

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

• EntryBatchAdminSession: a session to create, modify and delete entries in bulk
• BlogBatchAdminSession: a session to create, modify and delete blogs in bulk

Method Summary

Methods

Modifier and Type	Method and Description
BlogBatchAdminSession	getBlogBatchAdminSession() Gets the OsidSession associated with the bulk blog administration service.
EntryBatchAdminSession	getEntryBatchAdminSession() Gets the OsidSession associated with the bulk entry administration service.
EntryBatchAdminSession	getEntryBatchAdminSessionForBlog(Id blogId) Gets the OsidSession associated with the bulk entry administration service for the given blog.

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.blogging.batch.BloggingBatchProfile

supportsBlogBatchAdmin, supportsEntryBatchAdmin, 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

getEntryBatchAdminSession

EntryBatchAdminSession getEntryBatchAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk entry administration service.

Returns:

an EntryBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryBatchAdmin() is false

Compliance:

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

getEntryBatchAdminSessionForBlog

EntryBatchAdminSession getEntryBatchAdminSessionForBlog(Id blogId)
                                                        throws NotFoundException,
                                                               OperationFailedException

Gets the OsidSession associated with the bulk entry administration service for the given blog.

Parameters:

blogId - the Id of the Blog

Returns:

an EntryBatchAdminSession

Throws:

NotFoundException - no Blog found by the given Id

NullArgumentException - blogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getBlogBatchAdminSession

BlogBatchAdminSession getBlogBatchAdminSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk blog administration service.

Returns:

a BlogBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBlogBatchAdmin() is false

Compliance:

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