OSID - osid.blogging.BloggingManager Service Interface Definition

Interface	osid.blogging.BloggingManager
Implements	`osid.OsidManager`
Implements	`osid.blogging.BloggingProfile`
Description	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	getEntryLookupSession
Description	Gets the `OsidSession` associated with the entry lookup service.
Return	`osid.blogging.EntryLookupSession`		`an EntryLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEntryLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEntryLookup()` is `true.`
Method	getEntryLookupSessionForBlog
Description	Gets the `OsidSession` associated with the entry lookup service for the given blog.
Parameters	`osid.id.Id`	`blogId`	the `Id` of the blog
Return	`osid.blogging.EntryLookupSession`		`an EntryLookupSession`
Errors	NOT_FOUND		`blogId` not found
	NULL_ARGUMENT		`blogId` 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.
Return	`osid.blogging.EntryQuerySession`		`an EntryQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	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
Return	`osid.blogging.EntryQuerySession`		`an EntryQuerySession`
Errors	NOT_FOUND		`blogId` not found
	NULL_ARGUMENT		`blogId` 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.
Return	`osid.blogging.EntrySearchSession`		`an EntrySearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	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
Return	`osid.blogging.EntrySearchSession`		`an EntrySearchSession`
Errors	NOT_FOUND		`blogId` not found
	NULL_ARGUMENT		`blogId` 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.
Return	`osid.blogging.EntryAdminSession`		`an EntryAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	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
Return	`osid.blogging.EntryAdminSession`		`an EntryAdminSession`
Errors	NOT_FOUND		`blogId` not found
	NULL_ARGUMENT		`blogId` 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 notification session for notifications pertaining to entry changes.
Parameters	`osid.blogging.EntryReceiver`	`entryReceiver`	the notification callback
Return	`osid.blogging.EntryNotificationSession`		`an EntryNotificationSession`
Errors	NULL_ARGUMENT		`entryReceiver` 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`	the notification callback
Parameters	`osid.id.Id`	`blogId`	the `Id` of the blog
Return	`osid.blogging.EntryNotificationSession`		`an EntryNotificationSession`
Errors	NOT_FOUND		`blogId` not found
	NULL_ARGUMENT		`entryReceiver` or `blogId` 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.
Return	`osid.blogging.EntryBlogSession`		an `EntryBlogSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	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.
Return	`osid.blogging.EntryBlogAssignmentSession`		a `EntryBlogAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsEntryBlogAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEntryBlogAssignment()` is `true.`
Method	getEntrySmartBlogSession
Description	Gets the session for managing smart blogs for the given blog.
Parameters	`osid.id.Id`	`blogId`	the `Id` of the blog
Return	`osid.blogging.EntrySmartBlogSession`		an `EntrySmartBlogSession`
Errors	NOT_FOUND		`blogId` is not found
	NULL_ARGUMENT		`blogId` 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.
Return	`osid.blogging.BlogLookupSession`		a `BlogLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBlogLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBlogLookup()` is `true.`
Method	getBlogQuerySession
Description	Gets the blog query session.
Return	`osid.blogging.BlogQuerySession`		a `BlogQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBlogQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBlogQuery()` is `true.`
Method	getBlogSearchSession
Description	Gets the blog search session.
Return	`osid.blogging.BlogSearchSession`		a `BlogSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	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.
Return	`osid.blogging.BlogAdminSession`		a `BlogAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	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`	the notification callback
Return	`osid.blogging.BlogNotificationSession`		a `BlogNotificationSession`
Errors	NULL_ARGUMENT		`blogReceiver` 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.
Return	`osid.blogging.BlogHierarchySession`		`a BlogHierarchySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBlogHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBlogHierarchy()` is `true.`
Method	getBlogHierarchyDesignSession
Description	Gets the blog hierarchy design session.
Return	`osid.blogging.BlogHierarchyDesignSession`		a `BlogHierarchyDesignSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBlogHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBlogHierarchyDesign()` is `true.`
Method	getBloggingBatchManager
Description	Gets a `BloggingBatchManager.`
Return	`osid.blogging.batch.BloggingBatchManager`		a `BloggingBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsBloggingBatch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBloggingBatch()` is `true.`