Interface Receipt

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

A Message receipt is generated when a message is received by a receiving agent.

  • Method Details

    • getMessageId

      Id getMessageId()
      Gets the Id of the Message .
      Returns:
      the message Id
      Compliance:
      mandatory - This method must be implemented.

    • getMessage

      Message getMessage() throws OperationFailedException
      Gets the Message .
      Returns:
      the message
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getReceivedTime

      DateTime getReceivedTime()
      Gets the time the message was received.
      Returns:
      the time
      Compliance:
      mandatory - This method must be implemented.

    • getReceivingAgentId

      Id getReceivingAgentId()
      Gets the Id of the Agent that received this message at this endpoint.
      Returns:
      the receiving agent Id
      Compliance:
      mandatory - This method must be implemented.

    • getReceivingAgent

      Agent getReceivingAgent() throws OperationFailedException
      Gets the Agent that received this message at this endpoint.
      Returns:
      the receiving agent
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getRecipientId

      Id getRecipientId()
      Gets the Id of the Resource that received this message at this endpoint.
      Returns:
      the recipient Id
      Compliance:
      mandatory - This method must be implemented.

    • getRecipient

      Resource getRecipient() throws OperationFailedException
      Gets the Resource that received this message at this endpoint.
      Returns:
      the recipient
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getReceiptRecord

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