OSID Logo
OSID Specifications
messaging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.messaging.MailboxSearchOrder
Implementsosid.OsidCatalogSearchOrder
Description

An interface for specifying the ordering of search results.

MethodgetMailboxSearchOrderRecord
Description

Gets the mailbox search order record corresponding to the given mailbox record Type. Multiple retrievals return the same underlying object.

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