OSID Logo
OSID Specifications
messaging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.messaging.ReceiptQueryInspector
Implementsosid.OsidObjectQueryInspector
osid.OsidSubjugateableQueryInspector
Description

This is the query inspector for examining receipt queries.

MethodgetMessageIdTerms
Description

Gets the message Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetMessageTerms
Description

Gets the message query terms.

Returnosid.messaging.MessageQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetReceivedTimeTerms
Description

Gets the received time query terms.

Returnosid.search.terms.DateTimeRangeTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetReceivingAgentIdTerms
Description

Gets the receiving agent Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetReceivingAgentTerms
Description

Gets the receiving agent query terms.

Returnosid.authentication.AgentQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetRecipientIdTerms
Description

Gets the recipient Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetRecipientTerms
Description

Gets the recipient query terms.

Returnosid.resource.ResourceQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetMailboxIdTerms
Description

Gets the mailbox Id query terms.

Returnosid.search.terms.IdTerm[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetMailboxTerms
Description

Gets the mailbox query terms.

Returnosid.messaging.MailboxQueryInspector[]the query terms
CompliancemandatoryThis method must be implemented.
MethodgetReceiptQueryInspectorRecord
Description

Gets the receipt query inspector record corresponding to the given Receipt record Type.

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