OSID Logo
OSID Specifications
blogging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.blogging.BloggingProxyManager
Implementsosid.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 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
MethodgetEntryLookupSession
Description

Gets the OsidSession associated with the entry lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.blogging.EntryLookupSession an EntryLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntryLookup() is false
ComplianceoptionalThis method must be implemented if supportsEntryLookup() is true.
MethodgetEntryLookupSessionForBlog
Description

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

Parametersosid.id.IdblogIdthe Id of the blog
osid.proxy.Proxyproxya proxy
Returnosid.blogging.EntryLookupSession an EntryLookupSession
ErrorsNOT_FOUND blogId not found
NULL_ARGUMENT blogId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEntryLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEntryLookup() and supportsVisibleFederation() are true.
MethodgetEntryQuerySession
Description

Gets an entry query session.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.blogging.EntryQuerySession an EntryQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntryQuery() is false
ComplianceoptionalThis method must be implemented if supportsEntryQuery() is true.
MethodgetEntryQuerySessionForBlog
Description

Gets an entry query session for the given blog.

Parametersosid.id.IdblogIdthe Id of the blog
osid.proxy.Proxyproxya proxy
Returnosid.blogging.EntryQuerySession an EntryQuerySession
ErrorsNOT_FOUND blogId not found
NULL_ARGUMENT blogId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEntryQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEntryQuery() and supportsVisibleFederation() are true.
MethodgetEntrySearchSession
Description

Gets an entry search session.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.blogging.EntrySearchSession an EntrySearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntrySearch() is false
ComplianceoptionalThis method must be implemented if supportsEntrySearch() is true.
MethodgetEntrySearchSessionForBlog
Description

Gets an entry search session for the given blog.

Parametersosid.id.IdblogIdthe Id of the blog
osid.proxy.Proxyproxya proxy
Returnosid.blogging.EntrySearchSession an EntrySearchSession
ErrorsNOT_FOUND blogId not found
NULL_ARGUMENT blogId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEntrySearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEntrySearch() and supportsVisibleFederation() are true.
MethodgetEntryAdminSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.blogging.EntryAdminSession an EntryAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntryAdmin() is false
ComplianceoptionalThis method must be implemented if supportsEntryAdmin() is true.
MethodgetEntryAdminSessionForBlog
Description

Gets an entry administration session for the given blog.

Parametersosid.id.IdblogIdthe Id of the blog
osid.proxy.Proxyproxya proxy
Returnosid.blogging.EntryAdminSession an EntryAdminSession
ErrorsNOT_FOUND blogId not found
NULL_ARGUMENT blogId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntryAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEntryAdmin() and supportsVisibleFederation() are true.
MethodgetEntryNotificationSession
Description

Gets the entry notification session for the given blog.

Parametersosid.blogging.EntryReceiverentryReceivernotification callback
osid.proxy.Proxyproxya proxy
Returnosid.blogging.EntryNotificationSession an EntryNotificationSession
ErrorsNULL_ARGUMENT entryReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntryNotification() is false
ComplianceoptionalThis method must be implemented if supportsEntryNotification() is true.
MethodgetEntryNotificationSessionForBlog
Description

Gets the entry notification session for the given blog.

Parametersosid.blogging.EntryReceiverentryReceivernotification callback
osid.id.IdblogIdthe Id of the blog
osid.proxy.Proxyproxya proxy
Returnosid.blogging.EntryNotificationSession an EntryNotificationSession
ErrorsNOT_FOUND blogId not found
NULL_ARGUMENT entryReceiver, blogId or proxy is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsEntryNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEntryNotfication() and supportsVisibleFederation() are true.
MethodgetEntryBlogSession
Description

Gets the session for retrieving entry to blog mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.blogging.EntryBlogSessionan EntryBlogSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntryBlog() is false
ComplianceoptionalThis method must be implemented if supportsEntryBlog() is true.
MethodgetEntryBlogAssignmentSession
Description

Gets the session for assigning entry to blog mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.blogging.EntryBlogAssignmentSessionan EntryBlogAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntryBlogAssignment() is false
ComplianceoptionalThis method must be implemented if supportsEntryBlogAssignment() is true.
MethodgetEntrySmartBlogSession
Description

Gets the session managing smart blogs.

Parametersosid.id.IdblogIdthe Id of the blog
osid.proxy.Proxyproxya proxy
Returnosid.blogging.EntrySmartBlogSessiona EntrySmartBlogSession
ErrorsNOT_FOUND blogId is not found
NULL_ARGUMENT blogId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEntrySmartBlog() is false
ComplianceoptionalThis method must be implemented if supportsEntrySmartBlog() is true.
MethodgetBlogLookupSession
Description

Gets the blog lookup session.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.blogging.BlogLookupSessiona BlogLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBlogLookup() is false
ComplianceoptionalThis method must be implemented if supportsBlogLookup() is true.
MethodgetBlogQuerySession
Description

Gets the blog query session.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.blogging.BlogQuerySessiona BlogQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBlogQuery() is false
ComplianceoptionalThis method must be implemented if supportsBlogQuery() is true.
MethodgetBlogSearchSession
Description

Gets the blog search session.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.blogging.BlogSearchSessiona BlogSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBlogSearch() is false
ComplianceoptionalThis method must be implemented if supportsBlogSearch() is true.
MethodgetBlogAdminSession
Description

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

Parametersosid.proxy.Proxyproxya proxy
Returnosid.blogging.BlogAdminSessiona BlogAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBlogAdmin() is false
ComplianceoptionalThis method must be implemented if supportsBlogAdmin() is true.
MethodgetBlogNotificationSession
Description

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

Parametersosid.blogging.BlogReceiverblogReceivernotification callback
osid.proxy.Proxyproxya proxy
Returnosid.blogging.BlogNotificationSessiona BlogNotificationSession
ErrorsNULL_ARGUMENT blogReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBlogNotification() is false
ComplianceoptionalThis method must be implemented if supportsBlogNotification() is true.
MethodgetBlogHierarchySession
Description

Gets the blog hierarchy traversal session.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.blogging.BlogHierarchySession a BlogHierarchySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBlogHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsBlogHierarchy() is true.
MethodgetBlogHierarchyDesignSession
Description

Gets the blog hierarchy design session.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.blogging.BlogHierarchyDesignSessiona BlogHierarchyDesignSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBlogHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsBlogHierarchyDesign() is true.
MethodgetBloggingBatchProxyManager
Description

Gets a BloggingBatchProxyManager.

Returnosid.blogging.batch.BloggingBatchProxyManagera BloggingBatchProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBloggingBatch() is false
ComplianceoptionalThis method must be implemented if supportsBloggingBatch() is true.