OSID Logo
OSID Specifications
messaging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.messaging.ReceiptQuery
Implementsosid.OsidObjectQuery
osid.OsidSubjugateableQuery
Description

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.

MethodmatchMessageId
Description

Sets the message Id for this query.

Parametersosid.id.IdmessageIda message Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT messageId is null
CompliancemandatoryThis method must be implemented.
MethodclearMessageIdTerms
Description

Clears the message Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsMessageQuery
Description

Tests if a MessageQuery is available.

Returnboolean true if a message query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetMessageQuery
Description

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

Returnosid.messaging.MessageQuerythe message query
ErrorsUNIMPLEMENTED supportsMessageQuery() is false
ComplianceoptionalThis method must be implemented if supportsMessageQuery() is true.
MethodclearMessageTerms
Description

Clears the message terms.

CompliancemandatoryThis method must be implemented.
MethodmatchReceivedTime
Description

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

Parametersosid.calendaring.DateTimestartTimestart time
osid.calendaring.DateTimeendTimeend time
booleanmatch true if for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT startTime is greater than endTime
NULL_ARGUMENT startTime or endTime is null
CompliancemandatoryThis method must be implemented.
MethodclearReceivedTimeTerms
Description

Clears the received time terms.

CompliancemandatoryThis method must be implemented.
MethodmatchReceivingAgentId
Description

Matches the endpoint recipient of the message.

Parametersosid.id.IdagentId Id to match
booleanmatch true if for a positive match, false for a negative match
ErrorsNULL_ARGUMENT agentId is null
CompliancemandatoryThis method must be implemented.
MethodclearReceivingAgentIdTerms
Description

Clears the receiving agent Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsReceivingAgentQuery
Description

Tests if an AgentQuery is available for querying receiving agents.

Returnboolean true if an agent query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetReceivingAgentQuery
Description

Gets the query for the receiving agent.

Returnosid.authentication.AgentQuerythe agent query
ErrorsUNIMPLEMENTED supportsReceivingQuery() is false
ComplianceoptionalThis method must be implemented if supportsReceivingQuery() is true.
MethodclearReceivingAgentTerms
Description

Clears the receiving agent terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRecipientId
Description

Matches any recipient of the message.

Parametersosid.id.IdresourceId Id to match
booleanmatch true if for a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearRecipientIdTerms
Description

Clears the recipient Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRecipientQuery
Description

Tests if a ResourceQuery is available for querying recipients.

Returnboolean true if a resource query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRecipientQuery
Description

Gets the query for a recipient resource.

Returnosid.resource.ResourceQuerythe resource query
ErrorsUNIMPLEMENTED supportsRecipientQuery() is false
ComplianceoptionalThis method must be implemented if supportsRecipientQuery() is true.
MethodclearRecipientTerms
Description

Clears the recipient terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMailboxId
Description

Sets the mailbox Id for this query.

Parametersosid.id.IdmailboxIdthe mailbox Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT mailboxId is null
CompliancemandatoryThis method must be implemented.
MethodclearMailboxIdTerms
Description

Clears the mailbox Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsMailboxQuery
Description

Tests if a MailboxQuery is available.

Returnboolean true if a mailbox query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetMailboxQuery
Description

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

Returnosid.messaging.MailboxQuerythe mailbox query
ErrorsUNIMPLEMENTED supportsMailboxQuery() is false
ComplianceoptionalThis method must be implemented if supportsMailboxQuery() is true.
MethodclearMailboxTerms
Description

Clears the mailbox terms.

CompliancemandatoryThis method must be implemented.
MethodgetReceiptQueryRecord
Description

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

Parametersosid.type.TypereceiptRecordTypea receipt record type
Returnosid.messaging.records.ReceiptQueryRecordthe recript query record
ErrorsNULL_ARGUMENT receiptRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(receiptRecordType) is false
CompliancemandatoryThis method must be implemented.