org.osid.messaging

Interface MailboxSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidCatalogSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface MailboxSearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
MailboxSearchOrderRecord	getMailboxSearchOrderRecord(Type mailboxRecordType) Gets the mailbox search order record corresponding to the given mailbox record Type.

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getMailboxSearchOrderRecord

MailboxSearchOrderRecord getMailboxSearchOrderRecord(Type mailboxRecordType)
                                                     throws OperationFailedException

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

Parameters:

mailboxRecordType - a mailbox record type

Returns:

the mailbox search order record

Throws:

NullArgumentException - mailboxRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(mailboxRecordType) is false

Compliance:

mandatory - This method must be implemented.