OSID - osid.forum.ForumProfile Service Interface Definition

Interface	osid.forum.ForumProfile
Implements	`osid.OsidProfile`
Description	The reply profile describes the interoperability among forum services.
Method	supportsVisibleFederation
Description	Tests if any post federation is exposed. Federation is exposed when a specific post may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of posts appears as a single post.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPostLookup
Description	Tests for the availability of an post lookup service.
Return	`boolean`		`true` if post lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPostQuery
Description	Tests if querying posts is available.
Return	`boolean`		`true` if post query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPostSearch
Description	Tests if searching for posts is available.
Return	`boolean`		`true` if post search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPostAdmin
Description	Tests for the availability of a post administrative service for creating and deleting posts.
Return	`boolean`		`true` if post administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPostNotification
Description	Tests for the availability of a post notification service.
Return	`boolean`		`true` if post notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsPostForum
Description	Tests if a post to forum lookup session is available.
Return	`boolean`		`true` if post forum lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPostForumAssignment
Description	Tests if a post to forum assignment session is available.
Return	`boolean`		`true` if post forum assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsPostSmartForum
Description	Tests if a post smart foruming session is available.
Return	`boolean`		`true` if post smart foruming is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsReplyLookup
Description	Tests for the availability of a reply lookup service.
Return	`boolean`		`true` if reply lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsReplyAdmin
Description	Tests if searching for replies is available.
Return	`boolean`		`true` if reply search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsReplyNotification
Description	Tests if reply notification is available.
Return	`boolean`		`true` if reply notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsForumLookup
Description	Tests for the availability of an forum lookup service.
Return	`boolean`		`true` if forum lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsForumQuery
Description	Tests if querying forums is available.
Return	`boolean`		`true` if forum query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsForumSearch
Description	Tests if searching for forums is available.
Return	`boolean`		`true` if forum search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsForumAdmin
Description	Tests for the availability of a forum administrative service for creating and deleting forums.
Return	`boolean`		`true` if forum administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsForumNotification
Description	Tests for the availability of a forum notification service.
Return	`boolean`		`true` if forum notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsForumHierarchy
Description	Tests for the availability of a forum hierarchy traversal service.
Return	`boolean`		`true` if forum hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsForumHierarchyDesign
Description	Tests for the availability of a forum hierarchy design service.
Return	`boolean`		`true` if forum hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsForumBatch
Description	Tests if forum batch service is available.
Return	`boolean`		`true` if forum batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPostRecordTypes
Description	Gets the supported `Post` record types.
Return	`osid.type.TypeList`		a list containing the supported post record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPostRecordType
Description	Tests if the given `Post` record type is supported.
Parameters	`osid.type.Type`	`postRecordType`	a `Type` indicating a `Post` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`postRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPostSearchRecordTypes
Description	Gets the supported post search record types.
Return	`osid.type.TypeList`		a list containing the supported post search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsPostSearchRecordType
Description	Tests if the given post search record type is supported.
Parameters	`osid.type.Type`	`postSearchRecordType`	a `Type` indicating a post record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`postSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getReplyRecordTypes
Description	Gets the supported `Reply` record types.
Return	`osid.type.TypeList`		a list containing the supported reply record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsReplyRecordType
Description	Tests if the given `Reply` record type is supported.
Parameters	`osid.type.Type`	`replyRecordType`	a `Type` indicating a `Reply` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`replyRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getReplySearchRecordTypes
Description	Gets the supported reply search record types.
Return	`osid.type.TypeList`		a list containing the supported reply search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsReplySearchRecordType
Description	Tests if the given reply search record type is supported.
Parameters	`osid.type.Type`	`replySearchRecordType`	a `Type` indicating a reply record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`replySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getForumRecordTypes
Description	Gets the supported `Forum` record types.
Return	`osid.type.TypeList`		a list containing the supported forum record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsForumRecordType
Description	Tests if the given `Forum` record type is supported.
Parameters	`osid.type.Type`	`forumRecordType`	a `Type` indicating a `Forum` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`forumRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getForumSearchRecordTypes
Description	Gets the supported forum search record types.
Return	`osid.type.TypeList`		a list containing the supported forum search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsForumSearchRecordType
Description	Tests if the given forum search record type is supported.
Parameters	`osid.type.Type`	`forumSearchRecordType`	a `Type` indicating a forum record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`forumSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.