OSID Logo
OSID Specifications
messaging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.messaging.MailboxSearch
Implementsosid.OsidSearch
Description

The interface for governing mailbox searches.

MethodsearchAmongMailboxes
Description

Execute this search among the given list of mailboxes.

Parametersosid.id.IdListmailboxIdslist of mailboxes
ErrorsNULL_ARGUMENT mailboxIds is null
CompliancemandatoryThis method must be implemented.
MethodorderMailboxResults
Description

Specify an ordering to the search results.

Parametersosid.messaging.MailboxSearchOrdermailboxSearchOrdermailbox search order
ErrorsNULL_ARGUMENT mailboxSearchOrder is null
UNSUPPORTED mailboxSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetMailboxSearchRecord
Description

Gets the mailbox search 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.MailboxSearchRecordthe mailbox search record
ErrorsNULL_ARGUMENT mailboxSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(mailboxSearchRecordType) is false
CompliancemandatoryThis method must be implemented.