Interface MessageQueryInspector

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

This is the query inspector for examining message queries.

  • Method Details

    • getSubjectLineTerms

      StringTerm[] getSubjectLineTerms()
      Gets the subject line query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getTextTerms

      StringTerm[] getTextTerms()
      Gets the text query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getSentTerms

      BooleanTerm[] getSentTerms()
      Gets the sent query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getSentTimeTerms

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

    • getSenderIdTerms

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

    • getSenderTerms

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

    • getSendingAgentIdTerms

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

    • getSendingAgentTerms

      AgentQueryInspector[] getSendingAgentTerms()
      Gets the sending agent 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.

    • getDeliveryTimeTerms

      DurationRangeTerm[] getDeliveryTimeTerms()
      Gets the delivery time 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.

    • getReceiptIdTerms

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

    • getReceiptTerms

      ReceiptQueryInspector[] getReceiptTerms()
      Gets the receipt 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.

    • getMessageQueryInspectorRecord

      MessageQueryInspectorRecord getMessageQueryInspectorRecord(Type messageRecordType) throws OperationFailedException
      Gets the message query inspector record corresponding to the given Message record Type .
      Parameters:
      messageRecordType - a message record type
      Returns:
      the message query inspector record
      Throws:
      NullArgumentException - messageRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(messageRecordType) is false
      Compliance:
      mandatory - This method must be implemented.