OSID Logo
OSID Specifications
messaging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.messaging.MailboxQueryInspector
Implementsosid.OsidCatalogQueryInspector
Description

This is the query inspector for examining mailbox 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.
MethodgetAncestorMailboxIdTerms
Description

Gets the ancestor mailbox Id query terms.

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

Gets the ancestor mailbox query terms.

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

Gets the descendant mailbox Id query terms.

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

Gets the descendant mailbox query terms.

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

Gets the mailbox query inspector record corresponding to the given Mailbox record Type.

Parametersosid.type.TypemailboxRecordTypea mailbox record type
Returnosid.messaging.records.MailboxQueryInspectorRecordthe mailbox query inspector record
ErrorsNULL_ARGUMENT mailboxRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(mailboxRecordType) is false
CompliancemandatoryThis method must be implemented.