public interface ReceiptQuery extends OsidObjectQuery, OsidSubjugateableQuery
This is the query for searching message receipts. Each method specifies
an AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearMailboxIdTerms()
Clears the mailbox
Id terms. |
void |
clearMailboxTerms()
Clears the mailbox terms.
|
void |
clearMessageIdTerms()
Clears the message
Id terms. |
void |
clearMessageTerms()
Clears the message terms.
|
void |
clearReceivedTimeTerms()
Clears the received time terms.
|
void |
clearReceivingAgentIdTerms()
Clears the receiving agent
Id terms. |
void |
clearReceivingAgentTerms()
Clears the receiving agent terms.
|
void |
clearRecipientIdTerms()
Clears the recipient
Id terms. |
void |
clearRecipientTerms()
Clears the recipient terms.
|
MailboxQuery |
getMailboxQuery()
Gets the query for a mailbox.
|
MessageQuery |
getMessageQuery()
Gets the query for a message.
|
ReceiptQueryRecord |
getReceiptQueryRecord(Type receiptRecordType)
Gets the receipt query record corresponding to the given
Receipt record Type. |
AgentQuery |
getReceivingAgentQuery()
Gets the query for the receiving agent.
|
ResourceQuery |
getRecipientQuery()
Gets the query for a recipient resource.
|
void |
matchMailboxId(Id mailboxId,
boolean match)
Sets the mailbox
Id for this query. |
void |
matchMessageId(Id messageId,
boolean match)
Sets the message
Id for this query. |
void |
matchReceivedTime(DateTime startTime,
DateTime endTime,
boolean match)
Matches messages whose received time is between the supplied range
inclusive.
|
void |
matchReceivingAgentId(Id agentId,
boolean match)
Matches the endpoint recipient of the message.
|
void |
matchRecipientId(Id resourceId,
boolean match)
Matches any recipient of the message.
|
boolean |
supportsMailboxQuery()
Tests if a
MailboxQuery is available. |
boolean |
supportsMessageQuery()
Tests if a
MessageQuery is available. |
boolean |
supportsReceivingAgentQuery()
Tests if an
AgentQuery is available for querying
receiving agents. |
boolean |
supportsRecipientQuery()
Tests if a
ResourceQuery is available for querying
recipients. |
clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
void matchMessageId(Id messageId, boolean match)
Id
for this query.messageId
- a message Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- messageId
is
null
mandatory
- This method must be implemented. void clearMessageIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsMessageQuery()
MessageQuery
is available. true
if a message query is available,
false
otherwisemandatory
- This method must be implemented. MessageQuery getMessageQuery()
OR
term.UnimplementedException
- supportsMessageQuery()
is false
optional
- This method must be implemented if
supportsMessageQuery()
is true.
void clearMessageTerms()
mandatory
- This method must be implemented. void matchReceivedTime(DateTime startTime, DateTime endTime, boolean match)
startTime
- start timeendTime
- end timematch
- true
if for a positive match,
false
for a negative matchInvalidArgumentException
- startTime
is
greater than endTime
NullArgumentException
- startTime
or
endTime
is null
mandatory
- This method must be implemented. void clearReceivedTimeTerms()
mandatory
- This method must be implemented. void matchReceivingAgentId(Id agentId, boolean match)
agentId
- Id
to matchmatch
- true
if for a positive match,
false
for a negative matchNullArgumentException
- agentId
is
null
mandatory
- This method must be implemented. void clearReceivingAgentIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsReceivingAgentQuery()
AgentQuery
is available for querying
receiving agents. true
if an agent query is available,
false
otherwisemandatory
- This method must be implemented. AgentQuery getReceivingAgentQuery()
UnimplementedException
-
supportsReceivingQuery()
is false
optional
- This method must be implemented if
supportsReceivingQuery()
is true.
void clearReceivingAgentTerms()
mandatory
- This method must be implemented. void matchRecipientId(Id resourceId, boolean match)
resourceId
- Id
to matchmatch
- true
if for a positive match,
false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearRecipientIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsRecipientQuery()
ResourceQuery
is available for querying
recipients. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getRecipientQuery()
UnimplementedException
-
supportsRecipientQuery()
is false
optional
- This method must be implemented if
supportsRecipientQuery()
is true.
void clearRecipientTerms()
mandatory
- This method must be implemented. void matchMailboxId(Id mailboxId, boolean match)
Id
for this query.mailboxId
- the mailbox Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- mailboxId
is
null
mandatory
- This method must be implemented. void clearMailboxIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsMailboxQuery()
MailboxQuery
is available. true
if a mailbox query is available,
false
otherwisemandatory
- This method must be implemented. MailboxQuery getMailboxQuery()
OR
term.UnimplementedException
- supportsMailboxQuery()
is false
optional
- This method must be implemented if
supportsMailboxQuery()
is true.
void clearMailboxTerms()
mandatory
- This method must be implemented. ReceiptQueryRecord getReceiptQueryRecord(Type receiptRecordType) throws OperationFailedException
Receipt
record Type.
Multiple retrievals
produce a nested OR
term.receiptRecordType
- a receipt record typeNullArgumentException
- receiptRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(receiptRecordType)
is false
mandatory
- This method must be implemented.