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 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.
|
changeBranch, initialize, rollbackService
close
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
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
EntryLookupSession getEntryLookupSession() throws OperationFailedException
OsidSession
associated with the entry lookup
service. an EntryLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEntryLookup()
is false
optional
- This method must be implemented if
supportsEntryLookup()
is true.
EntryLookupSession getEntryLookupSessionForBlog(Id blogId) throws NotFoundException, OperationFailedException
OsidSession
associated with the entry lookup
service for the given blog.blogId
- the Id
of the blog an EntryLookupSession
NotFoundException
- blogId
not foundNullArgumentException
- blogId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsEntryLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsEntryLookup()
and
supportsVisibleFederation()
are true.
EntryQuerySession getEntryQuerySession() throws OperationFailedException
an EntryQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEntryQuery()
is false
optional
- This method must be implemented if
supportsEntryQuery()
is true.
EntryQuerySession getEntryQuerySessionForBlog(Id blogId) throws NotFoundException, OperationFailedException
blogId
- the Id
of the blog an EntryQuerySession
NotFoundException
- blogId
not foundNullArgumentException
- blogId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsEntryQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsEntryQuery()
and
supportsVisibleFederation()
are true.
EntrySearchSession getEntrySearchSession() throws OperationFailedException
an EntrySearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEntrySearch()
is false
optional
- This method must be implemented if
supportsEntrySearch()
is true.
EntrySearchSession getEntrySearchSessionForBlog(Id blogId) throws NotFoundException, OperationFailedException
blogId
- the Id
of the blog an EntrySearchSession
NotFoundException
- blogId
not foundNullArgumentException
- blogId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsEntrySearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsEntrySearch()
and
supportsVisibleFederation()
are true.
EntryAdminSession getEntryAdminSession() throws OperationFailedException
an EntryAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEntryAdmin()
is false
optional
- This method must be implemented if
supportsEntryAdmin()
is true.
EntryAdminSession getEntryAdminSessionForBlog(Id blogId) throws NotFoundException, OperationFailedException
blogId
- the Id
of the blog an EntryAdminSession
NotFoundException
- blogId
not foundNullArgumentException
- blogId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEntryAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsEntryAdmin()
and
supportsVisibleFederation()
are true.
EntryNotificationSession getEntryNotificationSession(EntryReceiver entryReceiver) throws OperationFailedException
entryReceiver
- the notification callback an EntryNotificationSession
NullArgumentException
- entryReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEntryNotification()
is false
optional
- This method must be implemented if
supportsEntryNotification()
is true.
EntryNotificationSession getEntryNotificationSessionForBlog(EntryReceiver entryReceiver, Id blogId) throws NotFoundException, OperationFailedException
entryReceiver
- the notification callbackblogId
- the Id
of the blog an EntryNotificationSession
NotFoundException
- blogId
not foundNullArgumentException
- entryReceiver
or
blogId
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsEntryNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsEntryNotfication()
and
supportsVisibleFederation()
are true.
EntryBlogSession getEntryBlogSession() throws OperationFailedException
EntryBlogSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsEntryBlog()
is false
optional
- This method must be implemented if
supportsEntryBlog()
is true.
EntryBlogAssignmentSession getEntryBlogAssignmentSession() throws OperationFailedException
EntryBlogAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEntryBlogAssignment()
is false
optional
- This method must be implemented if
supportsEntryBlogAssignment()
is true.
EntrySmartBlogSession getEntrySmartBlogSession(Id blogId) throws NotFoundException, OperationFailedException
blogId
- the Id
of the blog EntrySmartBlogSession
NotFoundException
- blogId
is not foundNullArgumentException
- blogId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsEntrySmartBlog()
is false
optional
- This method must be implemented if
supportsEntrySmartBlog()
is true.
BlogLookupSession getBlogLookupSession() throws OperationFailedException
BlogLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBlogLookup()
is false
optional
- This method must be implemented if
supportsBlogLookup()
is true.
BlogQuerySession getBlogQuerySession() throws OperationFailedException
BlogQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBlogQuery()
is false
optional
- This method must be implemented if
supportsBlogQuery()
is true.
BlogSearchSession getBlogSearchSession() throws OperationFailedException
BlogSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBlogSearch()
is false
optional
- This method must be implemented if
supportsBlogSearch()
is true.
BlogAdminSession getBlogAdminSession() throws OperationFailedException
BlogAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBlogAdmin()
is false
optional
- This method must be implemented if
supportsBlogAdmin()
is true.
BlogNotificationSession getBlogNotificationSession(BlogReceiver blogReceiver) throws OperationFailedException
blogReceiver
- the notification callback BlogNotificationSession
NullArgumentException
- blogReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBlogNotification()
is false
optional
- This method must be implemented if
supportsBlogNotification()
is true.
BlogHierarchySession getBlogHierarchySession() throws OperationFailedException
a BlogHierarchySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBlogHierarchy()
is false
optional
- This method must be implemented if
supportsBlogHierarchy()
is true.
BlogHierarchyDesignSession getBlogHierarchyDesignSession() throws OperationFailedException
BlogHierarchyDesignSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBlogHierarchyDesign()
is false
optional
- This method must be implemented if
supportsBlogHierarchyDesign()
is true.
BloggingBatchManager getBloggingBatchManager() throws OperationFailedException
BloggingBatchManager.
BloggingBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBloggingBatch()
is false
optional
- This method must be implemented if
supportsBloggingBatch()
is true.