Interface BloggingManager

All Superinterfaces:

AutoCloseable, BloggingProfile, Closeable, OsidManager, 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

Modifier and Type	Method	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 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

Modifier and Type	Method	Description
TypeList	getBlogRecordTypes()	Gets all the blog record types supported.
TypeList	getBlogSearchRecordTypes()	Gets all the blog search record types supported.
TypeList	getEntryRecordTypes()	Gets all the entry record types supported.
TypeList	getEntrySearchRecordTypes()	Gets all the entry search record types supported.
boolean	supportsBlogAdmin()	Tests if blog administration is supported.
boolean	supportsBlogging()	Tests if sending entries is supported.
boolean	supportsBloggingBatch()	Tests if a blogging batch service is supported.
boolean	supportsBlogHierarchy()	Tests if a blog hierarchy traversal is supported.
boolean	supportsBlogHierarchyDesign()	Tests if a blog hierarchy design is supported.
boolean	supportsBlogLookup()	Tests if blog lookup is supported.
boolean	supportsBlogNotification()	Tests if blog notification is supported.
boolean	supportsBlogQuery()	Tests if blog query is supported.
boolean	supportsBlogRecordType(Type blogRecordType)	Tests if a given blog record type is supported.
boolean	supportsBlogSearch()	Tests if blog search is supported.
boolean	supportsBlogSearchRecordType(Type blogSearchRecordType)	Tests if a given blog search record type is supported.
boolean	supportsEntryAdmin()	Tests if creating, updating and deleting entries is supported.
boolean	supportsEntryBlog()	Tests if retrieving mappings of entry and blogs is supported.
boolean	supportsEntryBlogAssignment()	Tests if managing mappings of entries and blogs is supported.
boolean	supportsEntryLookup()	Tests if entry lookup is supported.
boolean	supportsEntryNotification()	Tests if entry notification is supported.
boolean	supportsEntryQuery()	Tests if entry query is supported.
boolean	supportsEntryRecordType(Type entryRecordType)	Tests if a given entry record type is supported.
boolean	supportsEntrySearch()	Tests if entry search is supported.
boolean	supportsEntrySearchRecordType(Type entrySearchRecordType)	Tests if a given entry search type is supported.
boolean	supportsEntrySmartBlog()	Tests if entry smart blogging is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	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, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsEntryLookup()} is {@code 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 {@code supportsEntryLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEntryQuery()} is {@code 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 {@code supportsEntryQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEntrySearch()} is {@code 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 {@code supportsEntrySearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEntryAdmin()} is {@code 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 {@code supportsEntryAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEntryNotification()} is {@code 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 {@code supportsEntryNotfication()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEntryBlog()} is {@code 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 {@code supportsEntryBlogAssignment()} is {@code 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 {@code supportsEntrySmartBlog()} is {@code 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 {@code supportsBlogLookup()} is {@code 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 {@code supportsBlogQuery()} is {@code 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 {@code supportsBlogSearch()} is {@code 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 {@code supportsBlogAdmin()} is {@code 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 {@code supportsBlogNotification()} is {@code 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 {@code supportsBlogHierarchy()} is {@code 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 {@code supportsBlogHierarchyDesign()} is {@code 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 {@code supportsBloggingBatch()} is {@code true} .