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

Modifier and Type

Method

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 .Multiple retrievals produce a nested OR term.

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 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
- 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 {@code supportsMessageQuery()} is {@code 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 {@code supportsReceivingQuery()} is {@code 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 {@code supportsRecipientQuery()} is {@code 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 {@code supportsMailboxQuery()} is {@code 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.

Interface ReceiptQuery

Method Summary

Methods inherited from interface Extensible

Methods inherited from interface OsidExtensibleQuery

Methods inherited from interface OsidIdentifiableQuery

Methods inherited from interface OsidObjectQuery

Methods inherited from interface OsidQuery

Method Details

matchMessageId

clearMessageIdTerms

supportsMessageQuery

getMessageQuery

clearMessageTerms

matchReceivedTime

clearReceivedTimeTerms

matchReceivingAgentId

clearReceivingAgentIdTerms

supportsReceivingAgentQuery

getReceivingAgentQuery

clearReceivingAgentTerms

matchRecipientId

clearRecipientIdTerms

supportsRecipientQuery

getRecipientQuery

clearRecipientTerms

matchMailboxId

clearMailboxIdTerms

supportsMailboxQuery

getMailboxQuery

clearMailboxTerms

getReceiptQueryRecord