Interface BloggingProxyManager

All Superinterfaces:

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

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

close

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

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

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