public interface MessageQueryInspector extends OsidObjectQueryInspector
This is the query inspector for examining message queries.
Modifier and Type | Method and Description |
---|---|
DurationRangeTerm[] |
getDeliveryTimeTerms()
Gets the delivery time query terms.
|
IdTerm[] |
getMailboxIdTerms()
Gets the mailbox
Id query terms. |
MailboxQueryInspector[] |
getMailboxTerms()
Gets the mailbox query terms.
|
MessageQueryInspectorRecord |
getMessageQueryInspectorRecord(Type messageRecordType)
Gets the message query inspector record corresponding to the given
Message record Type. |
IdTerm[] |
getReceiptIdTerms()
Gets the receipt
Id query terms. |
ReceiptQueryInspector[] |
getReceiptTerms()
Gets the receipt query terms.
|
DateTimeRangeTerm[] |
getReceivedTimeTerms()
Gets the received time query terms.
|
IdTerm[] |
getRecipientIdTerms()
Gets the recipient
Id query terms. |
ResourceQueryInspector[] |
getRecipientTerms()
Gets the recipient query terms.
|
IdTerm[] |
getSenderIdTerms()
Gets the sender
Id query terms. |
ResourceQueryInspector[] |
getSenderTerms()
Gets the sender query terms.
|
IdTerm[] |
getSendingAgentIdTerms()
Gets the sending agent
Id query terms. |
AgentQueryInspector[] |
getSendingAgentTerms()
Gets the sending agent query terms.
|
BooleanTerm[] |
getSentTerms()
Gets the sent query terms.
|
DateTimeRangeTerm[] |
getSentTimeTerms()
Gets the sent time query terms.
|
StringTerm[] |
getSubjectLineTerms()
Gets the subject line query terms.
|
StringTerm[] |
getTextTerms()
Gets the text query terms.
|
getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms
getIdTerms
getRecordTypeTerms
getRecordTypes, hasRecordType
getAnyTerms, getKeywordTerms
StringTerm[] getSubjectLineTerms()
mandatory
- This method must be implemented. StringTerm[] getTextTerms()
mandatory
- This method must be implemented. BooleanTerm[] getSentTerms()
mandatory
- This method must be implemented. DateTimeRangeTerm[] getSentTimeTerms()
mandatory
- This method must be implemented. IdTerm[] getSenderIdTerms()
Id
query terms.mandatory
- This method must be implemented. ResourceQueryInspector[] getSenderTerms()
mandatory
- This method must be implemented. IdTerm[] getSendingAgentIdTerms()
Id
query terms.mandatory
- This method must be implemented. AgentQueryInspector[] getSendingAgentTerms()
mandatory
- This method must be implemented. DateTimeRangeTerm[] getReceivedTimeTerms()
mandatory
- This method must be implemented. DurationRangeTerm[] getDeliveryTimeTerms()
mandatory
- This method must be implemented. IdTerm[] getRecipientIdTerms()
Id
query terms.mandatory
- This method must be implemented. ResourceQueryInspector[] getRecipientTerms()
mandatory
- This method must be implemented. IdTerm[] getReceiptIdTerms()
Id
query terms.mandatory
- This method must be implemented. ReceiptQueryInspector[] getReceiptTerms()
mandatory
- This method must be implemented. IdTerm[] getMailboxIdTerms()
Id
query terms.mandatory
- This method must be implemented. MailboxQueryInspector[] getMailboxTerms()
mandatory
- This method must be implemented. MessageQueryInspectorRecord getMessageQueryInspectorRecord(Type messageRecordType) throws OperationFailedException
Message
record Type.
messageRecordType
- a message record typeNullArgumentException
- messageRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(messageRecordType)
is false
mandatory
- This method must be implemented.