Interface ReceiptQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSubjugateableQueryInspector
public interface ReceiptQueryInspector extends OsidObjectQueryInspector, OsidSubjugateableQueryInspector

This is the query inspector for examining receipt queries.

  • Method Details

    • getMessageIdTerms

      IdTerm[] getMessageIdTerms()
      Gets the message Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getMessageTerms

      MessageQueryInspector[] getMessageTerms()
      Gets the message query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getReceivedTimeTerms

      DateTimeRangeTerm[] getReceivedTimeTerms()
      Gets the received time query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getReceivingAgentIdTerms

      IdTerm[] getReceivingAgentIdTerms()
      Gets the receiving agent Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getReceivingAgentTerms

      AgentQueryInspector[] getReceivingAgentTerms()
      Gets the receiving agent query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getRecipientIdTerms

      IdTerm[] getRecipientIdTerms()
      Gets the recipient Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getRecipientTerms

      ResourceQueryInspector[] getRecipientTerms()
      Gets the recipient query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getMailboxIdTerms

      IdTerm[] getMailboxIdTerms()
      Gets the mailbox Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getMailboxTerms

      MailboxQueryInspector[] getMailboxTerms()
      Gets the mailbox query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getReceiptQueryInspectorRecord

      ReceiptQueryInspectorRecord getReceiptQueryInspectorRecord(Type receiptRecordType) throws OperationFailedException
      Gets the receipt query inspector record corresponding to the given Receipt record Type .
      Parameters:
      receiptRecordType - a receipt record type
      Returns:
      the receipt query inspector record
      Throws:
      NullArgumentException - receiptRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(receiptRecordType) is false
      Compliance:
      mandatory - This method must be implemented.