Interface Reply

All Superinterfaces:
Browsable, Containable, Extensible, Identifiable, OsidObject, Subjugateable
public interface Reply extends OsidObject, Containable, Subjugateable

A Reply is a response to a Post or another Reply .

  • Method Details

    • getPostId

      Id getPostId()
      Gets the Id of the original top level post for this reply.
      Returns:
      the post Id
      Compliance:
      mandatory - This method must be implemented.

    • getPost

      Post getPost() throws OperationFailedException
      Gets the original top level post.
      Returns:
      the post
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getReplyIds

      IdList getReplyIds()
      Gets the Ids of the replies to this rpely.
      Returns:
      the reply Ids
      Compliance:
      mandatory - This method must be implemented.

    • getReplies

      ReplyList getReplies() throws OperationFailedException
      Gets the replies to this reply.
      Returns:
      the replies
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getTimestamp

      DateTime getTimestamp()
      Gets the time of this entry.
      Returns:
      the time
      Compliance:
      mandatory - This method must be implemented.

    • getPosterId

      Id getPosterId()
      Gets the poster resource Id of this entry.
      Returns:
      the poster resource Id
      Compliance:
      mandatory - This method must be implemented.

    • getPoster

      Resource getPoster() throws OperationFailedException
      Gets the posting of this entry.
      Returns:
      the poster resource
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getPostingAgentId

      Id getPostingAgentId()
      Gets the posting Id of this entry.
      Returns:
      the posting agent Id
      Compliance:
      mandatory - This method must be implemented.

    • getPostingAgent

      Agent getPostingAgent() throws OperationFailedException
      Gets the posting of this entry.
      Returns:
      the posting agent
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getSubjectLine

      DisplayText getSubjectLine()
      Gets the subject line of this entry.
      Returns:
      the subject
      Compliance:
      mandatory - This method must be implemented.

    • getText

      DisplayText getText()
      Gets the text of the entry.
      Returns:
      the entry text
      Compliance:
      mandatory - This method must be implemented.

    • getReplyRecord

      ReplyRecord getReplyRecord(Type replyRecordType) throws OperationFailedException
      Gets the reply record corresponding to the given Reply record Type .This method is used to retrieve an object implementing the requested record. The replyRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(replyRecordType) is true .
      Parameters:
      replyRecordType - the type of reply record to retrieve
      Returns:
      the reply record
      Throws:
      NullArgumentException - replyRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(replyRecordType) is false
      Compliance:
      mandatory - This method must be implemented.