Interface CommentingProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
CommentingManager, CommentingProxyManager
public interface CommentingProfile extends OsidProfile

The commenting profile describes the interoperability among commenting services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      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.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCommentLookup

      boolean supportsCommentLookup()
      Tests for the availability of a comment lookup service.
      Returns:
      true if comment lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRatingLookup

      boolean supportsRatingLookup()
      Tests for the availability of a rating lookup service.
      Returns:
      true if rating lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCommentQuery

      boolean supportsCommentQuery()
      Tests if querying comments is available.
      Returns:
      true if comment query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCommentSearch

      boolean supportsCommentSearch()
      Tests if searching for comments is available.
      Returns:
      true if comment search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCommentAdmin

      boolean supportsCommentAdmin()
      Tests if managing comments is available.
      Returns:
      true if comment admin is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCommentNotification

      boolean supportsCommentNotification()
      Tests if comment notification is available.
      Returns:
      true if comment notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCommentBook

      boolean supportsCommentBook()
      Tests if a comment to book lookup session is available.
      Returns:
      true if comment book lookup session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCommentBookAssignment

      boolean supportsCommentBookAssignment()
      Tests if a comment to book assignment session is available.
      Returns:
      true if comment book assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsCommentSmartBook

      boolean supportsCommentSmartBook()
      Tests if a comment smart booking session is available.
      Returns:
      true if comment smart booking is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBookLookup

      boolean supportsBookLookup()
      Tests for the availability of a book lookup service.
      Returns:
      true if book lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBookQuery

      boolean supportsBookQuery()
      Tests if querying books is available.
      Returns:
      true if book query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBookSearch

      boolean supportsBookSearch()
      Tests if searching for books is available.
      Returns:
      true if book search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBookAdmin

      boolean supportsBookAdmin()
      Tests for the availability of a book administrative service for creating and deleting books.
      Returns:
      true if book administration is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBookNotification

      boolean supportsBookNotification()
      Tests for the availability of a book notification service.
      Returns:
      true if book notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsBookHierarchy

      boolean supportsBookHierarchy()
      Tests for the availability of a book hierarchy traversal service.
      Returns:
      true if book hierarchy traversal is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBookHierarchyDesign

      boolean supportsBookHierarchyDesign()
      Tests for the availability of a book hierarchy design service.
      Returns:
      true if book hierarchy design is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsCommentingBatch

      boolean supportsCommentingBatch()
      Tests for the availability of a commenting batch service.
      Returns:
      true if commenting batch service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • getCommentRecordTypes

      TypeList getCommentRecordTypes()
      Gets the supported Comment record types.
      Returns:
      a list containing the supported comment record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsCommentRecordType

      boolean supportsCommentRecordType(Type commentRecordType)
      Tests if the given Comment record type is supported.
      Parameters:
      commentRecordType - a Type indicating a Comment record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - commentRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getCommentSearchRecordTypes

      TypeList getCommentSearchRecordTypes()
      Gets the supported comment search record types.
      Returns:
      a list containing the supported comment search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsCommentSearchRecordType

      boolean supportsCommentSearchRecordType(Type commentSearchRecordType)
      Tests if the given comment search record type is supported.
      Parameters:
      commentSearchRecordType - a Type indicating a comment record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - commentSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getBookRecordTypes

      TypeList getBookRecordTypes()
      Gets the supported Book record types.
      Returns:
      a list containing the supported book record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsBookRecordType

      boolean supportsBookRecordType(Type bookRecordType)
      Tests if the given Book record type is supported.
      Parameters:
      bookRecordType - a Type indicating a Book record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - bookRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getBookSearchRecordTypes

      TypeList getBookSearchRecordTypes()
      Gets the supported book search record types.
      Returns:
      a list containing the supported book search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsBookSearchRecordType

      boolean supportsBookSearchRecordType(Type bookSearchRecordType)
      Tests if the given book search record type is supported.
      Parameters:
      bookSearchRecordType - a Type indicating a book record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - bookSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.