org.osid.blogging

Interface BloggingManager

All Superinterfaces:

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

public interface BloggingManager
extends OsidManager, BloggingProfile

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

• EntryLookupSession: a session to retrieve entries
• EntryQuerySession: a session for querying entries
• EntrySearchSession: a session to search for entries
• EntryAdminSession: a session to create and delete entries
• EntryNotificationSession: a session to receive notifications pertaining to entry changes
• EntryBlogSession: a session to look up entry to blog mappings
• EntryBlogAssignmentSession: a session to manage entry to blog mappings
• EntrySmartBlogSession: a session for managing dynamic blogs

• BlogLookupSession: a session to retrieve blogs
• BlogQuerySession: a session for querying blogs
• BlogSearchSession: a session to search for blogs
• BlogAdminSession: a session to create, update and delete blogs
• BlogNotificationSession: a session to receive notifications pertaining to changes in blogs
• BlogHierarchySession: a session to traverse blog hierarchies
• BlogHierarchyDesignSession: a session to manage blog hierarchies

Method Summary

Methods

Modifier and Type	Method and Description
BlogAdminSession	getBlogAdminSession() Gets the blog administrative session for creating, updating and deleteing blogs.
BloggingBatchManager	getBloggingBatchManager() Gets a BloggingBatchManager.
BlogHierarchyDesignSession	getBlogHierarchyDesignSession() Gets the blog hierarchy design session.
BlogHierarchySession	getBlogHierarchySession() Gets the blog hierarchy traversal session.
BlogLookupSession	getBlogLookupSession() Gets the blog lookup session.
BlogNotificationSession	getBlogNotificationSession(BlogReceiver blogReceiver) Gets the notification session for subscriblogg to changes to a blog.
BlogQuerySession	getBlogQuerySession() Gets the blog query session.
BlogSearchSession	getBlogSearchSession() Gets the blog search session.
EntryAdminSession	getEntryAdminSession() Gets an entry administration session for creating, updating and deleting entries.
EntryAdminSession	getEntryAdminSessionForBlog(Id blogId) Gets an entry administration session for the given blog.
EntryBlogAssignmentSession	getEntryBlogAssignmentSession() Gets the session for assigning entry to blog mappings.
EntryBlogSession	getEntryBlogSession() Gets the session for retrieving entry to blog mappings.
EntryLookupSession	getEntryLookupSession() Gets the OsidSession associated with the entry lookup service.
EntryLookupSession	getEntryLookupSessionForBlog(Id blogId) Gets the OsidSession associated with the entry lookup service for the given blog.
EntryNotificationSession	getEntryNotificationSession(EntryReceiver entryReceiver) Gets the notification session for notifications pertaining to entry changes.
EntryNotificationSession	getEntryNotificationSessionForBlog(EntryReceiver entryReceiver, Id blogId) Gets the entry notification session for the given blog.
EntryQuerySession	getEntryQuerySession() Gets an entry query session.
EntryQuerySession	getEntryQuerySessionForBlog(Id blogId) Gets an entry query session for the given blog.
EntrySearchSession	getEntrySearchSession() Gets an entry search session.
EntrySearchSession	getEntrySearchSessionForBlog(Id blogId) Gets an entry search session for the given blog.
EntrySmartBlogSession	getEntrySmartBlogSession(Id blogId) Gets the session for managing smart blogs 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.BloggingProfile

getBlogRecordTypes, getBlogSearchRecordTypes, getEntryRecordTypes, getEntrySearchRecordTypes, supportsBlogAdmin, supportsBlogging, supportsBloggingBatch, supportsBlogHierarchy, supportsBlogHierarchyDesign, supportsBlogLookup, supportsBlogNotification, supportsBlogQuery, supportsBlogRecordType, supportsBlogSearch, supportsBlogSearchRecordType, supportsEntryAdmin, supportsEntryBlog, supportsEntryBlogAssignment, supportsEntryLookup, supportsEntryNotification, supportsEntryQuery, supportsEntryRecordType, supportsEntrySearch, supportsEntrySearchRecordType, supportsEntrySmartBlog, 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

getEntryLookupSession

EntryLookupSession getEntryLookupSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the entry lookup service.

Returns:

an EntryLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryLookup() is false

Compliance:

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

getEntryLookupSessionForBlog

EntryLookupSession getEntryLookupSessionForBlog(Id blogId)
                                                throws NotFoundException,
                                                       OperationFailedException

Gets the OsidSession associated with the entry lookup service for the given blog.

Parameters:

blogId - the Id of the blog

Returns:

an EntryLookupSession

Throws:

NotFoundException - blogId not found

NullArgumentException - blogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryLookup() or supportsVisibleFederation() is false

Compliance:

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

getEntryQuerySession

EntryQuerySession getEntryQuerySession()
                                       throws OperationFailedException

Gets an entry query session.

Returns:

an EntryQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryQuery() is false

Compliance:

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

getEntryQuerySessionForBlog

EntryQuerySession getEntryQuerySessionForBlog(Id blogId)
                                              throws NotFoundException,
                                                     OperationFailedException

Gets an entry query session for the given blog.

Parameters:

blogId - the Id of the blog

Returns:

an EntryQuerySession

Throws:

NotFoundException - blogId not found

NullArgumentException - blogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryQuery() or supportsVisibleFederation() is false

Compliance:

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

getEntrySearchSession

EntrySearchSession getEntrySearchSession()
                                         throws OperationFailedException

Gets an entry search session.

Returns:

an EntrySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEntrySearch() is false

Compliance:

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

getEntrySearchSessionForBlog

EntrySearchSession getEntrySearchSessionForBlog(Id blogId)
                                                throws NotFoundException,
                                                       OperationFailedException

Gets an entry search session for the given blog.

Parameters:

blogId - the Id of the blog

Returns:

an EntrySearchSession

Throws:

NotFoundException - blogId not found

NullArgumentException - blogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntrySearch() or supportsVisibleFederation() is false

Compliance:

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

getEntryAdminSession

EntryAdminSession getEntryAdminSession()
                                       throws OperationFailedException

Gets an entry administration session for creating, updating and deleting entries.

Returns:

an EntryAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryAdmin() is false

Compliance:

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

getEntryAdminSessionForBlog

EntryAdminSession getEntryAdminSessionForBlog(Id blogId)
                                              throws NotFoundException,
                                                     OperationFailedException

Gets an entry administration session for the given blog.

Parameters:

blogId - the Id of the blog

Returns:

an EntryAdminSession

Throws:

NotFoundException - blogId not found

NullArgumentException - blogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryAdmin() or supportsVisibleFederation() is false

Compliance:

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

getEntryNotificationSession

EntryNotificationSession getEntryNotificationSession(EntryReceiver entryReceiver)
                                                     throws OperationFailedException

Gets the notification session for notifications pertaining to entry changes.

Parameters:

entryReceiver - the notification callback

Returns:

an EntryNotificationSession

Throws:

NullArgumentException - entryReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryNotification() is false

Compliance:

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

getEntryNotificationSessionForBlog

EntryNotificationSession getEntryNotificationSessionForBlog(EntryReceiver entryReceiver,
                                                          Id blogId)
                                                            throws NotFoundException,
                                                                   OperationFailedException

Gets the entry notification session for the given blog.

Parameters:

entryReceiver - the notification callback

blogId - the Id of the blog

Returns:

an EntryNotificationSession

Throws:

NotFoundException - blogId not found

NullArgumentException - entryReceiver or blogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryNotification() or supportsVisibleFederation() is false

Compliance:

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

getEntryBlogSession

EntryBlogSession getEntryBlogSession()
                                     throws OperationFailedException

Gets the session for retrieving entry to blog mappings.

Returns:

an EntryBlogSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryBlog() is false

Compliance:

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

getEntryBlogAssignmentSession

EntryBlogAssignmentSession getEntryBlogAssignmentSession()
                                                         throws OperationFailedException

Gets the session for assigning entry to blog mappings.

Returns:

a EntryBlogAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryBlogAssignment() is false

Compliance:

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

getEntrySmartBlogSession

EntrySmartBlogSession getEntrySmartBlogSession(Id blogId)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the session for managing smart blogs for the given blog.

Parameters:

blogId - the Id of the blog

Returns:

an EntrySmartBlogSession

Throws:

NotFoundException - blogId is not found

NullArgumentException - blogId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntrySmartBlog() is false

Compliance:

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

getBlogLookupSession

BlogLookupSession getBlogLookupSession()
                                       throws OperationFailedException

Gets the blog lookup session.

Returns:

a BlogLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBlogLookup() is false

Compliance:

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

getBlogQuerySession

BlogQuerySession getBlogQuerySession()
                                     throws OperationFailedException

Gets the blog query session.

Returns:

a BlogQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBlogQuery() is false

Compliance:

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

getBlogSearchSession

BlogSearchSession getBlogSearchSession()
                                       throws OperationFailedException

Gets the blog search session.

Returns:

a BlogSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBlogSearch() is false

Compliance:

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

getBlogAdminSession

BlogAdminSession getBlogAdminSession()
                                     throws OperationFailedException

Gets the blog administrative session for creating, updating and deleteing blogs.

Returns:

a BlogAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBlogAdmin() is false

Compliance:

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

getBlogNotificationSession

BlogNotificationSession getBlogNotificationSession(BlogReceiver blogReceiver)
                                                   throws OperationFailedException

Gets the notification session for subscriblogg to changes to a blog.

Parameters:

blogReceiver - the notification callback

Returns:

a BlogNotificationSession

Throws:

NullArgumentException - blogReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlogNotification() is false

Compliance:

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

getBlogHierarchySession

BlogHierarchySession getBlogHierarchySession()
                                             throws OperationFailedException

Gets the blog hierarchy traversal session.

Returns:

a BlogHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBlogHierarchy() is false

Compliance:

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

getBlogHierarchyDesignSession

BlogHierarchyDesignSession getBlogHierarchyDesignSession()
                                                         throws OperationFailedException

Gets the blog hierarchy design session.

Returns:

a BlogHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBlogHierarchyDesign() is false

Compliance:

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

getBloggingBatchManager

BloggingBatchManager getBloggingBatchManager()
                                             throws OperationFailedException

Gets a BloggingBatchManager.

Returns:

a BloggingBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBloggingBatch() is false

Compliance:

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