org.osid.messaging

Interface ReceiptQuery

All Superinterfaces:

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

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Method Detail

matchMessageId

void matchMessageId(Id messageId,
                  boolean match)

Sets the message Id for this query.

Parameters:

messageId - a message Id

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

Throws:

NullArgumentException - messageId is null

Compliance:

mandatory - This method must be implemented.

clearMessageIdTerms

void clearMessageIdTerms()

Clears the message Id terms.

Compliance:

mandatory - This method must be implemented.

supportsMessageQuery

boolean supportsMessageQuery()

Tests if a MessageQuery is available.

Returns:

true if a message query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getMessageQuery

MessageQuery getMessageQuery()

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

Returns:

the message query

Throws:

UnimplementedException - supportsMessageQuery() is false

Compliance:

optional - This method must be implemented if supportsMessageQuery() is true.

clearMessageTerms

void clearMessageTerms()

Clears the message 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.

matchReceivingAgentId

void matchReceivingAgentId(Id agentId,
                         boolean match)

Matches the endpoint recipient 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.

clearReceivingAgentIdTerms

void clearReceivingAgentIdTerms()

Clears the receiving agent Id terms.

Compliance:

mandatory - This method must be implemented.

supportsReceivingAgentQuery

boolean supportsReceivingAgentQuery()

Tests if an AgentQuery is available for querying receiving agents.

Returns:

true if an agent query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getReceivingAgentQuery

AgentQuery getReceivingAgentQuery()

Gets the query for the receiving agent.

Returns:

the agent query

Throws:

UnimplementedException - supportsReceivingQuery() is false

Compliance:

optional - This method must be implemented if supportsReceivingQuery() is true.

clearReceivingAgentTerms

void clearReceivingAgentTerms()

Clears the receiving agent 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 supportsRecipientQuery() is true.

clearRecipientTerms

void clearRecipientTerms()

Clears the recipient 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 supportsMailboxQuery() is true.

clearMailboxTerms

void clearMailboxTerms()

Clears the mailbox terms.

Compliance:

mandatory - This method must be implemented.

getReceiptQueryRecord

ReceiptQueryRecord getReceiptQueryRecord(Type receiptRecordType)
                                         throws OperationFailedException

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

Parameters:

receiptRecordType - a receipt record type

Returns:

the recript query record

Throws:

NullArgumentException - receiptRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(receiptRecordType) is false

Compliance:

mandatory - This method must be implemented.