OSID - osid.commenting.CommentingProfile Service Interface Definition

Interface	osid.commenting.CommentingProfile
Implements	`osid.OsidProfile`
Description	The commenting profile describes the interoperability among commenting services.
Method	supportsVisibleFederation
Description	Tests if any book federation is exposed. Federation is exposed when a specific book may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of books appears as a single book.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCommentLookup
Description	Tests for the availability of a comment lookup service.
Return	`boolean`		`true` if comment lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRatingLookup
Description	Tests for the availability of a rating lookup service.
Return	`boolean`		`true` if rating lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCommentQuery
Description	Tests if querying comments is available.
Return	`boolean`		`true` if comment query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCommentSearch
Description	Tests if searching for comments is available.
Return	`boolean`		`true` if comment search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCommentAdmin
Description	Tests if managing comments is available.
Return	`boolean`		`true` if comment admin is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCommentNotification
Description	Tests if comment notification is available.
Return	`boolean`		`true` if comment notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCommentBook
Description	Tests if a comment to book lookup session is available.
Return	`boolean`		`true` if comment book lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCommentBookAssignment
Description	Tests if a comment to book assignment session is available.
Return	`boolean`		`true` if comment book assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsCommentSmartBook
Description	Tests if a comment smart booking session is available.
Return	`boolean`		`true` if comment smart booking is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBookLookup
Description	Tests for the availability of an book lookup service.
Return	`boolean`		`true` if book lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBookQuery
Description	Tests if querying books is available.
Return	`boolean`		`true` if book query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBookSearch
Description	Tests if searching for books is available.
Return	`boolean`		`true` if book search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBookAdmin
Description	Tests for the availability of a book administrative service for creating and deleting books.
Return	`boolean`		`true` if book administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBookNotification
Description	Tests for the availability of a book notification service.
Return	`boolean`		`true` if book notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsBookHierarchy
Description	Tests for the availability of a book hierarchy traversal service.
Return	`boolean`		`true` if book hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBookHierarchyDesign
Description	Tests for the availability of a book hierarchy design service.
Return	`boolean`		`true` if book hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsCommentingBatch
Description	Tests for the availability of a commenting batch service.
Return	`boolean`		`true` if commenting batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	getCommentRecordTypes
Description	Gets the supported `Comment` record types.
Return	`osid.type.TypeList`		a list containing the supported comment record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCommentRecordType
Description	Tests if the given `Comment` record type is supported.
Parameters	`osid.type.Type`	`commentRecordType`	a `Type` indicating a `Comment` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`commentRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCommentSearchRecordTypes
Description	Gets the supported comment search record types.
Return	`osid.type.TypeList`		a list containing the supported comment search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsCommentSearchRecordType
Description	Tests if the given comment search record type is supported.
Parameters	`osid.type.Type`	`commentSearchRecordType`	a `Type` indicating a comment record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`commentSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBookRecordTypes
Description	Gets the supported `Book` record types.
Return	`osid.type.TypeList`		a list containing the supported book record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsBookRecordType
Description	Tests if the given `Book` record type is supported.
Parameters	`osid.type.Type`	`bookRecordType`	a `Type` indicating a `Book` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`bookRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBookSearchRecordTypes
Description	Gets the supported book search record types.
Return	`osid.type.TypeList`		a list containing the supported book search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsBookSearchRecordType
Description	Tests if the given book search record type is supported.
Parameters	`osid.type.Type`	`bookSearchRecordType`	a `Type` indicating a book record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`bookSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.