Interface MessageQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, Suppliable

public interface MessageQuery
extends OsidObjectQuery

This is the query for searching messages. Each method specifies an AND term while multiple invocations of the same method produce a nested OR .

Method Summary

Modifier and Type	Method	Description
void	clearDeliveryTimeTerms()	Clears the delivery time terms.
void	clearMailboxIdTerms()	Clears the mailbox Id terms.
void	clearMailboxTerms()	Clears the mailbox terms.
void	clearReceiptIdTerms()	Clears the receipt Id terms.
void	clearReceiptTerms()	Clears the receipt terms.
void	clearReceivedTimeTerms()	Clears the received time terms.
void	clearRecipientIdTerms()	Clears the recipient Id terms.
void	clearRecipientTerms()	Clears the recipient terms.
void	clearSenderIdTerms()	Clears the sender Id terms.
void	clearSenderTerms()	Clears the sender terms.
void	clearSendingAgentIdTerms()	Clears the sending agent Id terms.
void	clearSendingAgentTerms()	Clears the sending agent terms.
void	clearSentTerms()	Clears the sent terms.
void	clearSentTimeTerms()	Clears the sent time terms.
void	clearSubjectLineTerms()	Clears the subject line terms.
void	clearTextTerms()	Clears the text terms.
MailboxQuery	getMailboxQuery()	Gets the query for a mailbox.
MessageQueryRecord	getMessageQueryRecord(Type messageRecordType)	Gets the message query record corresponding to the given Message record Type .Multiple retrievals produce a nested OR term.
ReceiptQuery	getReceiptQuery()	Gets the query for the receipt.
ResourceQuery	getRecipientQuery()	Gets the query for a recipient resource.
ResourceQuery	getSenderQuery()	Gets the query for a resource.
AgentQuery	getSendingAgentQuery()	Gets the query for an agent.
void	matchAnyReceipt(boolean match)	Matches any received messages.
void	matchAnySubjectLine(boolean match)	Matches messages with any subject line.
void	matchAnyText(boolean match)	Matches messages with any text.
void	matchDeliveryTime(Duration start, Duration end, boolean match)	Matches messages whose delivery duration is between the supplied range inclusive.
void	matchMailboxId(Id mailboxId, boolean match)	Sets the mailbox Id for this query.
void	matchReceiptId(Id receiptId, boolean match)	Matches the receipt of the message.
void	matchReceivedTime(DateTime startTime, DateTime endTime, boolean match)	Matches messages whose received time is between the supplied range inclusive.
void	matchRecipientId(Id resourceId, boolean match)	Matches any recipient of the message.
void	matchSenderId(Id resourceId, boolean match)	Matches the sender of the message.
void	matchSendingAgentId(Id agentId, boolean match)	Matches the sending agent of the message.
void	matchSent(boolean match)	Matches messages that have been sent.
void	matchSentTime(DateTime startTime, DateTime endTime, boolean match)	Matches messages whose sent time is between the supplied range inclusive.
void	matchSubjectLine(String subject, Type stringMatchType, boolean match)	Adds a subject line to match.
void	matchText(String text, Type stringMatchType, boolean match)	Adds text to match.
boolean	supportsMailboxQuery()	Tests if a MailboxQuery is available.
boolean	supportsReceiptQuery()	Tests if a ReceiptQuery is available for querying receipts.
boolean	supportsRecipientQuery()	Tests if a ResourceQuery is available for querying recipients.
boolean	supportsSenderQuery()	Tests if a ResourceQuery is available for querying senders.
boolean	supportsSendingAgentQuery()	Tests if an AgentQuery is available for querying senders.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface OsidObjectQuery

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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Method Details

matchSubjectLine

void matchSubjectLine(String subject,
 Type stringMatchType,
 boolean match)

Adds a subject line to match. Multiple subject line matches can be added to perform a boolean OR among them.

Parameters:

subject - subject to match

stringMatchType - the string match type

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - subject is not of stringMatchType

NullArgumentException - subject or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnySubjectLine

void matchAnySubjectLine(boolean match)

Matches messages with any subject line.

Parameters:

match - true to match messages with any subject line, false to match messages with no subject line

Compliance:

mandatory - This method must be implemented.

clearSubjectLineTerms

void clearSubjectLineTerms()

Clears the subject line terms.

Compliance:

mandatory - This method must be implemented.

matchText

void matchText(String text,
 Type stringMatchType,
 boolean match)

Adds text to match. Multiple subject line matches can be added to perform a boolean OR among them.

Parameters:

text - dtext to match

stringMatchType - the string match type

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - text is not of stringMatchType

NullArgumentException - text or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyText

void matchAnyText(boolean match)

Matches messages with any text.

Parameters:

match - true to match messages with any text, false to match messages with no text

Compliance:

mandatory - This method must be implemented.

clearTextTerms

void clearTextTerms()

Clears the text terms.

Compliance:

mandatory - This method must be implemented.

matchSent

void matchSent(boolean match)

Matches messages that have been sent.

Parameters:

match - true to match sent messages, false to match unsent messages

Compliance:

mandatory - This method must be implemented.

clearSentTerms

void clearSentTerms()

Clears the sent terms.

Compliance:

mandatory - This method must be implemented.

matchSentTime

void matchSentTime(DateTime startTime,
 DateTime endTime,
 boolean match)

Matches messages whose sent time is between the supplied range inclusive.

Parameters:

startTime - start time

endTime - end time

match - true if for a positive match, false for a negative match

Throws:

InvalidArgumentException - startTime is greater than endTime

NullArgumentException - startTime or endTime is null

Compliance:

mandatory - This method must be implemented.

clearSentTimeTerms

void clearSentTimeTerms()

Clears the sent time terms.

Compliance:

mandatory - This method must be implemented.

matchSenderId

void matchSenderId(Id resourceId,
 boolean match)

Matches the sender of the message.

Parameters:

resourceId - Id to match

match - true if for a positive match, false for a negative match

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearSenderIdTerms

void clearSenderIdTerms()

Clears the sender Id terms.

Compliance:

mandatory - This method must be implemented.

supportsSenderQuery

boolean supportsSenderQuery()

Tests if a ResourceQuery is available for querying senders.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSenderQuery

ResourceQuery getSenderQuery()

Gets the query for a resource.

Returns:

the resource query

Throws:

UnimplementedException - supportsSenderQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSenderQuery()} is {@code true} .

clearSenderTerms

void clearSenderTerms()

Clears the sender terms.

Compliance:

mandatory - This method must be implemented.

matchSendingAgentId

void matchSendingAgentId(Id agentId,
 boolean match)

Matches the sending agent of the message.

Parameters:

agentId - Id to match

match - true if for a positive match, false for a negative match

Throws:

NullArgumentException - agentId is null

Compliance:

mandatory - This method must be implemented.

clearSendingAgentIdTerms

void clearSendingAgentIdTerms()

Clears the sending agent Id terms.

Compliance:

mandatory - This method must be implemented.

supportsSendingAgentQuery

boolean supportsSendingAgentQuery()

Tests if an AgentQuery is available for querying senders.

Returns:

true if an agent query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSendingAgentQuery

AgentQuery getSendingAgentQuery()

Gets the query for an agent.

Returns:

the agent query

Throws:

UnimplementedException - supportsSendingAgentQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSendingAgentQuery()} is {@code true} .

clearSendingAgentTerms

void clearSendingAgentTerms()

Clears the sending agent terms.

Compliance:

mandatory - This method must be implemented.

matchReceivedTime

void matchReceivedTime(DateTime startTime,
 DateTime endTime,
 boolean match)

Matches messages whose received time is between the supplied range inclusive.

Parameters:

startTime - start time

endTime - end time

match - true if for a positive match, false for a negative match

Throws:

InvalidArgumentException - startTime is greater than endTime

NullArgumentException - startTime or endTime is null

Compliance:

mandatory - This method must be implemented.

clearReceivedTimeTerms

void clearReceivedTimeTerms()

Clears the received time terms.

Compliance:

mandatory - This method must be implemented.

matchDeliveryTime

void matchDeliveryTime(Duration start,
 Duration end,
 boolean match)

Matches messages whose delivery duration is between the supplied range inclusive.

Parameters:

start - start time

end - end time

match - true if for a positive match, false for a negative match

Throws:

InvalidArgumentException - start is greater than end

NullArgumentException - start or end is null

Compliance:

mandatory - This method must be implemented.

clearDeliveryTimeTerms

void clearDeliveryTimeTerms()

Clears the delivery time terms.

Compliance:

mandatory - This method must be implemented.

matchRecipientId

void matchRecipientId(Id resourceId,
 boolean match)

Matches any recipient of the message.

Parameters:

resourceId - Id to match

match - true if for a positive match, false for a negative match

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearRecipientIdTerms

void clearRecipientIdTerms()

Clears the recipient Id terms.

Compliance:

mandatory - This method must be implemented.

supportsRecipientQuery

boolean supportsRecipientQuery()

Tests if a ResourceQuery is available for querying recipients.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRecipientQuery

ResourceQuery getRecipientQuery()

Gets the query for a recipient resource.

Returns:

the resource query

Throws:

UnimplementedException - supportsRecipientQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsRecipientQuery()} is {@code true} .

clearRecipientTerms

void clearRecipientTerms()

Clears the recipient terms.

Compliance:

mandatory - This method must be implemented.

matchReceiptId

void matchReceiptId(Id receiptId,
 boolean match)

Matches the receipt of the message.

Parameters:

receiptId - Id to match

match - true if for a positive match, false for a negative match

Throws:

NullArgumentException - receiptId is null

Compliance:

mandatory - This method must be implemented.

clearReceiptIdTerms

void clearReceiptIdTerms()

Clears the receipt Id terms.

Compliance:

mandatory - This method must be implemented.

supportsReceiptQuery

boolean supportsReceiptQuery()

Tests if a ReceiptQuery is available for querying receipts.

Returns:

true if a receipt query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getReceiptQuery

ReceiptQuery getReceiptQuery()

Gets the query for the receipt.

Returns:

the receipt query

Throws:

UnimplementedException - supportsReceiptQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsReceiptQuery()} is {@code true} .

matchAnyReceipt

void matchAnyReceipt(boolean match)

Matches any received messages.

Parameters:

match - true to match any received messages, false otherwise

Compliance:

mandatory - This method must be implemented.

clearReceiptTerms

void clearReceiptTerms()

Clears the receipt terms.

Compliance:

mandatory - This method must be implemented.

matchMailboxId

void matchMailboxId(Id mailboxId,
 boolean match)

Sets the mailbox Id for this query.

Parameters:

mailboxId - the mailbox Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - mailboxId is null

Compliance:

mandatory - This method must be implemented.

clearMailboxIdTerms

void clearMailboxIdTerms()

Clears the mailbox Id terms.

Compliance:

mandatory - This method must be implemented.

supportsMailboxQuery

boolean supportsMailboxQuery()

Tests if a MailboxQuery is available.

Returns:

true if a mailbox query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getMailboxQuery

MailboxQuery getMailboxQuery()

Gets the query for a mailbox. Multiple retrievals produce a nested OR term.

Returns:

the mailbox query

Throws:

UnimplementedException - supportsMailboxQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsMailboxQuery()} is {@code true} .

clearMailboxTerms

void clearMailboxTerms()

Clears the mailbox terms.

Compliance:

mandatory - This method must be implemented.

getMessageQueryRecord

MessageQueryRecord getMessageQueryRecord(Type messageRecordType)
                                  throws OperationFailedException

Gets the message query record corresponding to the given Message record Type .Multiple retrievals produce a nested OR term.

Parameters:

messageRecordType - a message record type

Returns:

the message query record

Throws:

NullArgumentException - messageRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(messageRecordType) is false

Compliance:

mandatory - This method must be implemented.