org.osid.blogging

Interface BloggingProxyManager

All Superinterfaces:

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

public interface BloggingProxyManager
extends OsidProxyManager, BloggingProfile

The blogging manager provides access to entry lookup and creation session and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object for the purposes of passing information from a server environment. 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(Proxy proxy) Gets the blog administrative session for creating, updating and deleteing blogs.
BloggingBatchProxyManager	getBloggingBatchProxyManager() Gets a BloggingBatchProxyManager.
BlogHierarchyDesignSession	getBlogHierarchyDesignSession(Proxy proxy) Gets the blog hierarchy design session.
BlogHierarchySession	getBlogHierarchySession(Proxy proxy) Gets the blog hierarchy traversal session.
BlogLookupSession	getBlogLookupSession(Proxy proxy) Gets the blog lookup session.
BlogNotificationSession	getBlogNotificationSession(BlogReceiver blogReceiver, Proxy proxy) Gets the notification session for subscriblogg to changes to a blog.
BlogQuerySession	getBlogQuerySession(Proxy proxy) Gets the blog query session.
BlogSearchSession	getBlogSearchSession(Proxy proxy) Gets the blog search session.
EntryAdminSession	getEntryAdminSession(Proxy proxy) Gets an entry administration session for creating, updating and deleting entries.
EntryAdminSession	getEntryAdminSessionForBlog(Id blogId, Proxy proxy) Gets an entry administration session for the given blog.
EntryBlogAssignmentSession	getEntryBlogAssignmentSession(Proxy proxy) Gets the session for assigning entry to blog mappings.
EntryBlogSession	getEntryBlogSession(Proxy proxy) Gets the session for retrieving entry to blog mappings.
EntryLookupSession	getEntryLookupSession(Proxy proxy) Gets the OsidSession associated with the entry lookup service.
EntryLookupSession	getEntryLookupSessionForBlog(Id blogId, Proxy proxy) Gets the OsidSession associated with the entry lookup service for the given blog.
EntryNotificationSession	getEntryNotificationSession(EntryReceiver entryReceiver, Proxy proxy) Gets the entry notification session for the given blog.
EntryNotificationSession	getEntryNotificationSessionForBlog(EntryReceiver entryReceiver, Id blogId, Proxy proxy) Gets the entry notification session for the given blog.
EntryQuerySession	getEntryQuerySession(Proxy proxy) Gets an entry query session.
EntryQuerySession	getEntryQuerySessionForBlog(Id blogId, Proxy proxy) Gets an entry query session for the given blog.
EntrySearchSession	getEntrySearchSession(Proxy proxy) Gets an entry search session.
EntrySearchSession	getEntrySearchSessionForBlog(Id blogId, Proxy proxy) Gets an entry search session for the given blog.
EntrySmartBlogSession	getEntrySmartBlogSession(Id blogId, Proxy proxy) Gets the session managing smart blogs.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

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(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the entry lookup service.

Parameters:

proxy - a proxy

Returns:

an EntryLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

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

Parameters:

blogId - the Id of the blog

proxy - a proxy

Returns:

an EntryLookupSession

Throws:

NotFoundException - blogId not found

NullArgumentException - blogId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets an entry query session.

Parameters:

proxy - a proxy

Returns:

an EntryQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                            Proxy proxy)
                                              throws NotFoundException,
                                                     OperationFailedException

Gets an entry query session for the given blog.

Parameters:

blogId - the Id of the blog

proxy - a proxy

Returns:

an EntryQuerySession

Throws:

NotFoundException - blogId not found

NullArgumentException - blogId or proxy 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(Proxy proxy)
                                         throws OperationFailedException

Gets an entry search session.

Parameters:

proxy - a proxy

Returns:

an EntrySearchSession

Throws:

NullArgumentException - proxy is null

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,
                                              Proxy proxy)
                                                throws NotFoundException,
                                                       OperationFailedException

Gets an entry search session for the given blog.

Parameters:

blogId - the Id of the blog

proxy - a proxy

Returns:

an EntrySearchSession

Throws:

NotFoundException - blogId not found

NullArgumentException - blogId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

an EntryAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                            Proxy proxy)
                                              throws NotFoundException,
                                                     OperationFailedException

Gets an entry administration session for the given blog.

Parameters:

blogId - the Id of the blog

proxy - a proxy

Returns:

an EntryAdminSession

Throws:

NotFoundException - blogId not found

NullArgumentException - blogId or proxy 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,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the entry notification session for the given blog.

Parameters:

entryReceiver - notification callback

proxy - a proxy

Returns:

an EntryNotificationSession

Throws:

NullArgumentException - entryReceiver or proxy 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,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

Gets the entry notification session for the given blog.

Parameters:

entryReceiver - notification callback

blogId - the Id of the blog

proxy - a proxy

Returns:

an EntryNotificationSession

Throws:

NotFoundException - blogId not found

NullArgumentException - entryReceiver, blogId or proxy 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(Proxy proxy)
                                     throws OperationFailedException

Gets the session for retrieving entry to blog mappings.

Parameters:

proxy - a proxy

Returns:

an EntryBlogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEntryBlog() is false

Compliance:

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

getEntryBlogAssignmentSession

EntryBlogAssignmentSession getEntryBlogAssignmentSession(Proxy proxy)
                                                         throws OperationFailedException

Gets the session for assigning entry to blog mappings.

Parameters:

proxy - a proxy

Returns:

an EntryBlogAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                             Proxy proxy)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the session managing smart blogs.

Parameters:

blogId - the Id of the blog

proxy - a proxy

Returns:

a EntrySmartBlogSession

Throws:

NotFoundException - blogId is not found

NullArgumentException - blogId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the blog lookup session.

Parameters:

proxy - a proxy

Returns:

a BlogLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlogLookup() is false

Compliance:

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

getBlogQuerySession

BlogQuerySession getBlogQuerySession(Proxy proxy)
                                     throws OperationFailedException

Gets the blog query session.

Parameters:

proxy - a proxy

Returns:

a BlogQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlogQuery() is false

Compliance:

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

getBlogSearchSession

BlogSearchSession getBlogSearchSession(Proxy proxy)
                                       throws OperationFailedException

Gets the blog search session.

Parameters:

proxy - a proxy

Returns:

a BlogSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlogSearch() is false

Compliance:

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

getBlogAdminSession

BlogAdminSession getBlogAdminSession(Proxy proxy)
                                     throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a BlogAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                 Proxy proxy)
                                                   throws OperationFailedException

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

Parameters:

blogReceiver - notification callback

proxy - a proxy

Returns:

a BlogNotificationSession

Throws:

NullArgumentException - blogReceiver or proxy 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(Proxy proxy)
                                             throws OperationFailedException

Gets the blog hierarchy traversal session.

Parameters:

proxy - a proxy

Returns:

a BlogHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlogHierarchy() is false

Compliance:

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

getBlogHierarchyDesignSession

BlogHierarchyDesignSession getBlogHierarchyDesignSession(Proxy proxy)
                                                         throws OperationFailedException

Gets the blog hierarchy design session.

Parameters:

proxy - a proxy

Returns:

a BlogHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlogHierarchyDesign() is false

Compliance:

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

getBloggingBatchProxyManager

BloggingBatchProxyManager getBloggingBatchProxyManager()
                                                       throws OperationFailedException

Gets a BloggingBatchProxyManager.

Returns:

a BloggingBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBloggingBatch() is false

Compliance:

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