public interface CommentingProfile extends OsidProfile
The commenting profile describes the interoperability among commenting services.
Modifier and Type | Method and Description |
---|---|
TypeList |
getBookRecordTypes()
Gets the supported
Book record types. |
TypeList |
getBookSearchRecordTypes()
Gets the supported book search record types.
|
TypeList |
getCommentRecordTypes()
Gets the supported
Comment record types. |
TypeList |
getCommentSearchRecordTypes()
Gets the supported comment search record types.
|
boolean |
supportsBookAdmin()
Tests for the availability of a book administrative service for
creating and deleting books.
|
boolean |
supportsBookHierarchy()
Tests for the availability of a book hierarchy traversal service.
|
boolean |
supportsBookHierarchyDesign()
Tests for the availability of a book hierarchy design service.
|
boolean |
supportsBookLookup()
Tests for the availability of an book lookup service.
|
boolean |
supportsBookNotification()
Tests for the availability of a book notification service.
|
boolean |
supportsBookQuery()
Tests if querying books is available.
|
boolean |
supportsBookRecordType(Type bookRecordType)
Tests if the given
Book record type is supported. |
boolean |
supportsBookSearch()
Tests if searching for books is available.
|
boolean |
supportsBookSearchRecordType(Type bookSearchRecordType)
Tests if the given book search record type is supported.
|
boolean |
supportsCommentAdmin()
Tests if managing comments is available.
|
boolean |
supportsCommentBook()
Tests if a comment to book lookup session is available.
|
boolean |
supportsCommentBookAssignment()
Tests if a comment to book assignment session is available.
|
boolean |
supportsCommentingBatch()
Tests for the availability of a commenting batch service.
|
boolean |
supportsCommentLookup()
Tests for the availability of a comment lookup service.
|
boolean |
supportsCommentNotification()
Tests if comment notification is available.
|
boolean |
supportsCommentQuery()
Tests if querying comments is available.
|
boolean |
supportsCommentRecordType(Type commentRecordType)
Tests if the given
Comment record type is supported. |
boolean |
supportsCommentSearch()
Tests if searching for comments is available.
|
boolean |
supportsCommentSearchRecordType(Type commentSearchRecordType)
Tests if the given comment search record type is supported.
|
boolean |
supportsCommentSmartBook()
Tests if a comment smart booking session is available.
|
boolean |
supportsRatingLookup()
Tests for the availability of a rating lookup service.
|
boolean |
supportsVisibleFederation()
Tests if any book federation is exposed.
|
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
boolean supportsVisibleFederation()
true
if visible federation is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsCommentLookup()
true
if comment lookup is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsRatingLookup()
true
if rating lookup is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsCommentQuery()
true
if comment query is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsCommentSearch()
true
if comment search is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsCommentAdmin()
true
if comment admin is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsCommentNotification()
true
if comment notification is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsCommentBook()
true
if comment book lookup session is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsCommentBookAssignment()
true
if comment book assignment is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsCommentSmartBook()
true
if comment smart booking is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsBookLookup()
true
if book lookup is available, false
otherwisemandatory
- This method must be implemented. boolean supportsBookQuery()
true
if book query is available, false
otherwisemandatory
- This method must be implemented. boolean supportsBookSearch()
true
if book search is available, false
otherwisemandatory
- This method must be implemented. boolean supportsBookAdmin()
true
if book administration is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsBookNotification()
true
if book notification is available,
false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsBookHierarchy()
true
if book hierarchy traversal is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsBookHierarchyDesign()
true
if book hierarchy design is available,
false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsCommentingBatch()
true
if commenting batch service is available,
false
otherwisemandatory
- This method must be implemented in all
providers. TypeList getCommentRecordTypes()
Comment
record types.mandatory
- This method must be implemented. boolean supportsCommentRecordType(Type commentRecordType)
Comment
record type is supported.commentRecordType
- a Type
indicating a
Comment
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- commentRecordType
is null
mandatory
- This method must be implemented. TypeList getCommentSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsCommentSearchRecordType(Type commentSearchRecordType)
commentSearchRecordType
- a Type
indicating a
comment record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- commentSearchRecordType
is null
mandatory
- This method must be implemented. TypeList getBookRecordTypes()
Book
record types.mandatory
- This method must be implemented. boolean supportsBookRecordType(Type bookRecordType)
Book
record type is supported.bookRecordType
- a Type
indicating a Book
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- bookRecordType
is null
mandatory
- This method must be implemented. TypeList getBookSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsBookSearchRecordType(Type bookSearchRecordType)
bookSearchRecordType
- a Type
indicating a book
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- bookSearchRecordType
is null
mandatory
- This method must be implemented.