OSID Logo
OSID Specifications
messaging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.messaging.MailboxSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetMailboxes
Description

Gets the mailbox list resulting from the search.

Returnosid.messaging.MailboxListthe mailbox list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetMailboxQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.messaging.MailboxQueryInspectorthe mailbox query inspector
CompliancemandatoryThis method must be implemented.
MethodgetMailboxSearchResultsRecord
Description

Gets the mailbox search results record corresponding to the given mailbox search record Type. This method must be used to retrieve an object implementing the requested record interface along with all of its ancestor interfaces.

Parametersosid.type.TypemailboxSearchRecordTypea mailbox search record type
Returnosid.messaging.records.MailboxSearchResultsRecordthe mailbox search results record
ErrorsNULL_ARGUMENT mailboxSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(mailboxSearchRecordType) is false
CompliancemandatoryThis method must be implemented.