Interface ForumProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
ForumManager, ForumProxyManager
public interface ForumProfile extends OsidProfile

The reply profile describes the interoperability among forum services.

  • Method Details

    • supportsVisibleFederation

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

    • supportsPostLookup

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

    • supportsPostQuery

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

    • supportsPostSearch

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

    • supportsPostAdmin

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

    • supportsPostNotification

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

    • supportsPostForum

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

    • supportsPostForumAssignment

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

    • supportsPostSmartForum

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

    • supportsReplyLookup

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

    • supportsReplyAdmin

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

    • supportsReplyNotification

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

    • supportsForumLookup

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

    • supportsForumQuery

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

    • supportsForumSearch

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

    • supportsForumAdmin

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

    • supportsForumNotification

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

    • supportsForumHierarchy

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

    • supportsForumHierarchyDesign

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

    • supportsForumBatch

      boolean supportsForumBatch()
      Tests if forum batch service is available.
      Returns:
      true if forum batch service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getPostRecordTypes

      TypeList getPostRecordTypes()
      Gets the supported Post record types.
      Returns:
      a list containing the supported post record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsPostRecordType

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

    • getPostSearchRecordTypes

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

    • supportsPostSearchRecordType

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

    • getReplyRecordTypes

      TypeList getReplyRecordTypes()
      Gets the supported Reply record types.
      Returns:
      a list containing the supported reply record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsReplyRecordType

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

    • getReplySearchRecordTypes

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

    • supportsReplySearchRecordType

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

    • getForumRecordTypes

      TypeList getForumRecordTypes()
      Gets the supported Forum record types.
      Returns:
      a list containing the supported forum record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsForumRecordType

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

    • getForumSearchRecordTypes

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

    • supportsForumSearchRecordType

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