Interface | osid.blogging.BloggingProxyManager | ||
---|---|---|---|
Implements | osid.OsidProxyManager | ||
osid.blogging.BloggingProfile | |||
Description |
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
| ||
Method | getEntryLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.blogging.EntryLookupSession | an EntryLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEntryLookup() is false | ||
Compliance | optional | This method must be implemented if supportsEntryLookup() is
true. | |
Method | getEntryLookupSessionForBlog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | blogId | the Id of the blog |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.blogging.EntryLookupSession | an EntryLookupSession | |
Errors | NOT_FOUND | blogId not found | |
NULL_ARGUMENT | blogId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEntryLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsEntryLookup() and
supportsVisibleFederation() are true. | |
Method | getEntryQuerySession | ||
Description |
Gets an entry query session. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.blogging.EntryQuerySession | an EntryQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEntryQuery() is false | ||
Compliance | optional | This method must be implemented if supportsEntryQuery() is
true. | |
Method | getEntryQuerySessionForBlog | ||
Description |
Gets an entry query session for the given blog. | ||
Parameters | osid.id.Id | blogId | the Id of the blog |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.blogging.EntryQuerySession | an EntryQuerySession | |
Errors | NOT_FOUND | blogId not found | |
NULL_ARGUMENT | blogId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEntryQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsEntryQuery() and
supportsVisibleFederation() are true. | |
Method | getEntrySearchSession | ||
Description |
Gets an entry search session. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.blogging.EntrySearchSession | an EntrySearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEntrySearch() is false | ||
Compliance | optional | This method must be implemented if supportsEntrySearch() is
true. | |
Method | getEntrySearchSessionForBlog | ||
Description |
Gets an entry search session for the given blog. | ||
Parameters | osid.id.Id | blogId | the Id of the blog |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.blogging.EntrySearchSession | an EntrySearchSession | |
Errors | NOT_FOUND | blogId not found | |
NULL_ARGUMENT | blogId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEntrySearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsEntrySearch() and
supportsVisibleFederation() are true. | |
Method | getEntryAdminSession | ||
Description |
Gets an entry administration session for creating, updating and deleting entries. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.blogging.EntryAdminSession | an EntryAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEntryAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsEntryAdmin() is
true. | |
Method | getEntryAdminSessionForBlog | ||
Description |
Gets an entry administration session for the given blog. | ||
Parameters | osid.id.Id | blogId | the Id of the blog |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.blogging.EntryAdminSession | an EntryAdminSession | |
Errors | NOT_FOUND | blogId not found | |
NULL_ARGUMENT | blogId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEntryAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsEntryAdmin() and
supportsVisibleFederation() are true. | |
Method | getEntryNotificationSession | ||
Description |
Gets the entry notification session for the given blog. | ||
Parameters | osid.blogging.EntryReceiver | entryReceiver | notification callback |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.blogging.EntryNotificationSession | an EntryNotificationSession | |
Errors | NULL_ARGUMENT | entryReceiver or proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEntryNotification() is false | ||
Compliance | optional | This method must be implemented if supportsEntryNotification()
is true. | |
Method | getEntryNotificationSessionForBlog | ||
Description |
Gets the entry notification session for the given blog. | ||
Parameters | osid.blogging.EntryReceiver | entryReceiver | notification callback |
osid.id.Id | blogId | the Id of the blog | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.blogging.EntryNotificationSession | an EntryNotificationSession | |
Errors | NOT_FOUND | blogId not found | |
NULL_ARGUMENT | entryReceiver, blogId or proxy is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEntryNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsEntryNotfication()
and supportsVisibleFederation() are true.
| |
Method | getEntryBlogSession | ||
Description |
Gets the session for retrieving entry to blog mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.blogging.EntryBlogSession | an EntryBlogSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEntryBlog() is false | ||
Compliance | optional | This method must be implemented if supportsEntryBlog() is
true. | |
Method | getEntryBlogAssignmentSession | ||
Description |
Gets the session for assigning entry to blog mappings. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.blogging.EntryBlogAssignmentSession | an EntryBlogAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEntryBlogAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsEntryBlogAssignment()
is true. | |
Method | getEntrySmartBlogSession | ||
Description |
Gets the session managing smart blogs. | ||
Parameters | osid.id.Id | blogId | the Id of the blog |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.blogging.EntrySmartBlogSession | a EntrySmartBlogSession | |
Errors | NOT_FOUND | blogId is not found | |
NULL_ARGUMENT | blogId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsEntrySmartBlog() is false | ||
Compliance | optional | This method must be implemented if supportsEntrySmartBlog()
is true. | |
Method | getBlogLookupSession | ||
Description |
Gets the blog lookup session. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.blogging.BlogLookupSession | a BlogLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlogLookup() is false | ||
Compliance | optional | This method must be implemented if supportsBlogLookup() is
true. | |
Method | getBlogQuerySession | ||
Description |
Gets the blog query session. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.blogging.BlogQuerySession | a BlogQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlogQuery() is false | ||
Compliance | optional | This method must be implemented if supportsBlogQuery() is
true. | |
Method | getBlogSearchSession | ||
Description |
Gets the blog search session. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.blogging.BlogSearchSession | a BlogSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlogSearch() is false | ||
Compliance | optional | This method must be implemented if supportsBlogSearch() is
true. | |
Method | getBlogAdminSession | ||
Description |
Gets the blog administrative session for creating, updating and deleteing blogs. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.blogging.BlogAdminSession | a BlogAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlogAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsBlogAdmin() is
true. | |
Method | getBlogNotificationSession | ||
Description |
Gets the notification session for subscriblogg to changes to a blog. | ||
Parameters | osid.blogging.BlogReceiver | blogReceiver | notification callback |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.blogging.BlogNotificationSession | a BlogNotificationSession | |
Errors | NULL_ARGUMENT | blogReceiver or proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlogNotification() is false | ||
Compliance | optional | This method must be implemented if supportsBlogNotification()
is true. | |
Method | getBlogHierarchySession | ||
Description |
Gets the blog hierarchy traversal session. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.blogging.BlogHierarchySession | a BlogHierarchySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlogHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsBlogHierarchy()
is true. | |
Method | getBlogHierarchyDesignSession | ||
Description |
Gets the blog hierarchy design session. | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.blogging.BlogHierarchyDesignSession | a BlogHierarchyDesignSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlogHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if supportsBlogHierarchyDesign()
is true. | |
Method | getBloggingBatchProxyManager | ||
Description |
Gets a | ||
Return | osid.blogging.batch.BloggingBatchProxyManager | a BloggingBatchProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBloggingBatch() is false | ||
Compliance | optional | This method must be implemented if supportsBloggingBatch()
is true. |