OSID - osid.forum.ForumManager Service Interface Definition

Interface	osid.forum.ForumManager
Implements	`osid.OsidManager`
Implements	`osid.forum.ForumProfile`
Description	The reply manager provides access to forum sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `PostLookupSession:` a session to retrieve posts `PostQuerySession:` a session to query posts `PostSearchSession:` a session to search for posts `PostAdminSession:` a session to create, update and delete posts `PostNotificationSession:` a session to receive notifications for changes in posts `PostForumSession:` a session to lookup post forum mappings `PostForumAssignmentSession:` a session to manage post forum mappings `PostSmartForumSession:` a session to manage smart forums of posts `ReplyLookupSession:` a session to lookup replies `ReplyAdminSession:` a session to manage replies `ReplyNotificationSession:` a session to subscribe to notifications of reply changes `ForumLookupSession:` a session to retrieve forums `ForumQuerySession:` a session to query forums `ForumSearchSession:` a session to search for forums `ForumAdminSession:` a session to create, update and delete forums `ForumNotificationSession:` a session to receive notifications for changes in forums `ForumHierarchySession:` a session to traverse hierarchies of forums `ForumHierarchyDesignSession:` a session to manage hierarchies of forums The forum manager also provides a profile for determing the supported search types supported by this service.
Method	getPostLookupSession
Description	Gets the `OsidSession` associated with the post lookup service.
Return	`osid.forum.PostLookupSession`		a `PostLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPostLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostLookup()` is `true.`
Method	getPostLookupSessionForForum
Description	Gets the `OsidSession` associated with the post lookup service for the given forum.
Parameters	`osid.id.Id`	`forumId`	the `Id` of the `Post`
Return	`osid.forum.PostLookupSession`		a `PostLookupSession`
Errors	NOT_FOUND		no `Forum` found by the given `Id`
	NULL_ARGUMENT		`forumId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostLookup()` and `supportsVisibleFederation()` are `true`
Method	getPostQuerySession
Description	Gets the `OsidSession` associated with the post query service.
Return	`osid.forum.PostQuerySession`		a `PostQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPostQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostQuery()` is `true.`
Method	getPostQuerySessionForForum
Description	Gets the `OsidSession` associated with the post query service for the given forum.
Parameters	`osid.id.Id`	`forumId`	the `Id` of the `Post`
Return	`osid.forum.PostQuerySession`		a `PostQuerySession`
Errors	NOT_FOUND		no `Forum` found by the given `Id`
	NULL_ARGUMENT		`forumId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostQuery()` and `supportsVisibleFederation()` are `true`
Method	getPostSearchSession
Description	Gets the `OsidSession` associated with the post search service.
Return	`osid.forum.PostSearchSession`		a `PostSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPostSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostSearch()` is `true.`
Method	getPostSearchSessionForForum
Description	Gets the `OsidSession` associated with the post search service for the given forum.
Parameters	`osid.id.Id`	`forumId`	the `Id` of the `Post`
Return	`osid.forum.PostSearchSession`		a `PostSearchSession`
Errors	NOT_FOUND		no `Forum` found by the given `Id`
	NULL_ARGUMENT		`forumId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostSearch()` and `supportsVisibleFederation()` are `true`
Method	getPostAdminSession
Description	Gets the `OsidSession` associated with the post administrative service.
Return	`osid.forum.PostAdminSession`		a `PostAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPostAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostAdmin()` is `true.`
Method	getPostAdminSessionForForum
Description	Gets the `OsidSession` associated with the post administrative service for the given forum.
Parameters	`osid.id.Id`	`forumId`	the `Id` of the `Post`
Return	`osid.forum.PostAdminSession`		a `PostAdminSession`
Errors	NOT_FOUND		no `Forum` found by the given `Id`
	NULL_ARGUMENT		`forumId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostAdmin()` and `supportsVisibleFederation()` are `true`
Method	getPostNotificationSession
Description	Gets the `OsidSession` associated with the post notification service.
Parameters	`osid.forum.PostReceiver`	`postReceiver`	the receiver
Return	`osid.forum.PostNotificationSession`		a `PostNotificationSession`
Errors	NULL_ARGUMENT		`postReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostNotification()` is `true.`
Method	getPostNotificationSessionForForum
Description	Gets the `OsidSession` associated with the post notification service for the given forum.
Parameters	`osid.forum.PostReceiver`	`postReceiver`	the receiver
Parameters	`osid.id.Id`	`forumId`	the `Id` of the `Forum`
Return	`osid.forum.PostNotificationSession`		a `PostNotificationSession`
Errors	NOT_FOUND		no `Forum` found by the given `Id`
	NULL_ARGUMENT		`postReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostNotification()` and `supportsVisibleFederation()` are `true`
Method	getPostForumSession
Description	Gets the session for retrieving post to forum mappings.
Return	`osid.forum.PostForumSession`		a `PostForumSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPostForum()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostForum()` is `true.`
Method	getPostForumAssignmentSession
Description	Gets the session for assigning post to forum mappings.
Return	`osid.forum.PostForumAssignmentSession`		a `PostForumAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsPostForumAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostForumAssignment()` is `true.`
Method	getPostSmartForumSession
Description	Gets the session associated with the post smart forum for the given forum.
Parameters	`osid.id.Id`	`forumId`	the `Id` of the forum
Return	`osid.forum.PostSmartForumSession`		a `PostSmartForumSession`
Errors	NOT_FOUND		`forumId` not found
	NULL_ARGUMENT		`forumId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsPostSmartForum()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPostSmartForum()` is `true.`
Method	getReplyLookupSession
Description	Gets the `OsidSession` associated with the reply lookup service.
Return	`osid.forum.ReplyLookupSession`		a `ReplyLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsReplyLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsReplyLookup()` is `true.`
Method	getReplyLookupSessionForForum
Description	Gets the `OsidSession` associated with the reply lookup service for the given forum.
Parameters	`osid.id.Id`	`forumId`	the `Id` of the `Forum`
Return	`osid.forum.ReplyLookupSession`		a `ReplyLookupSession`
Errors	NOT_FOUND		no `Forum` found by the given `Id`
	NULL_ARGUMENT		`forumId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsReplyLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsReplyLookup()` and `supportsVisibleFederation()` are `true`
Method	getReplyAdminSession
Description	Gets the `OsidSession` associated with the reply administration service.
Return	`osid.forum.ReplyAdminSession`		a `ReplyAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsReplyAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsReplyAdmin()` is `true.`
Method	getReplyAdminSessionForForum
Description	Gets the `OsidSession` associated with the reply administration service for the given forum.
Parameters	`osid.id.Id`	`forumId`	the `Id` of the `Forum`
Return	`osid.forum.ReplyAdminSession`		a `ReplyAdminSession`
Errors	NOT_FOUND		no `Forum` found by the given `Id`
	NULL_ARGUMENT		`forumId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsReplyAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsReplyAdmin()` and `supportsVisibleFederation()` are `true`
Method	getReplyNotificationSession
Description	Gets the `OsidSession` associated with the reply notification service.
Parameters	`osid.forum.ReplyReceiver`	`replyReceiver`	the receiver
Return	`osid.forum.ReplyNotificationSession`		a `ReplyNotificationSession`
Errors	NULL_ARGUMENT		`replyReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsReplyNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsReplyNotification()` is `true.`
Method	getReplyNotificationSessionForForum
Description	Gets the `OsidSession` associated with the reply notification service for the given forum.
Parameters	`osid.forum.ReplyReceiver`	`replyReceiver`	the receiver
Parameters	`osid.id.Id`	`forumId`	the `Id` of the `Forum`
Return	`osid.forum.ReplyNotificationSession`		a `ReplyNotificationSession`
Errors	NOT_FOUND		no `Forum` found by the given `Id`
	NULL_ARGUMENT		`replyReceiver` or `forumId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsReplyNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsReplyNotification()` and `supportsVisibleFederation()` are `true`
Method	getForumLookupSession
Description	Gets the `OsidSession` associated with the forum lookup service.
Return	`osid.forum.ForumLookupSession`		a `ForumLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsForumLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsForumLookup()` is `true.`
Method	getForumQuerySession
Description	Gets the `OsidSession` associated with the forum query service.
Return	`osid.forum.ForumQuerySession`		a `ForumQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsForumQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsForumQuery()` is `true.`
Method	getForumSearchSession
Description	Gets the `OsidSession` associated with the forum search service.
Return	`osid.forum.ForumSearchSession`		a `ForumSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsForumSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsForumSearch()` is `true.`
Method	getForumAdminSession
Description	Gets the `OsidSession` associated with the forum administrative service.
Return	`osid.forum.ForumAdminSession`		a `ForumAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsForumAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsForumAdmin()` is `true.`
Method	getForumNotificationSession
Description	Gets the `OsidSession` associated with the forum notification service.
Parameters	`osid.forum.ForumReceiver`	`forumReceiver`	the receiver
Return	`osid.forum.ForumNotificationSession`		a `ForumNotificationSession`
Errors	NULL_ARGUMENT		`forumReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsForumNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsForumNotification()` is `true.`
Method	getForumHierarchySession
Description	Gets the `OsidSession` associated with the forum hierarchy service.
Return	`osid.forum.ForumHierarchySession`		a `ForumHierarchySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsForumHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsForumHierarchy()` is `true.`
Method	getForumHierarchyDesignSession
Description	Gets the `OsidSession` associated with the forum hierarchy design service.
Return	`osid.forum.ForumHierarchyDesignSession`		a `ForumHierarchyDesignSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsForumHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsForumHierarchyDesign()` is `true.`
Method	getForumBatchManager
Description	Gets a `ForumBatchManager.`
Return	`osid.forum.batch.ForumBatchManager`		a `ForumBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsForumBatch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsForumBatch()` is `true.`