Interface MailboxSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface MailboxSearch
extends OsidSearch

The interface for governing mailbox searches.

Method Summary

Modifier and Type	Method	Description
MailboxSearchRecord	getMailboxSearchRecord(Type mailboxSearchRecordType)	Gets the mailbox search record corresponding to the given mailbox search record Type.
void	orderMailboxResults(MailboxSearchOrder mailboxSearchOrder)	Specify an ordering to the search results.
void	searchAmongMailboxes(IdList mailboxIds)	Execute this search among the given list of mailboxes.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongMailboxes

void searchAmongMailboxes(IdList mailboxIds)

Execute this search among the given list of mailboxes.

Parameters:

mailboxIds - list of mailboxes

Throws:

NullArgumentException - mailboxIds is null

Compliance:

mandatory - This method must be implemented.

orderMailboxResults

void orderMailboxResults(MailboxSearchOrder mailboxSearchOrder)

Specify an ordering to the search results.

Parameters:

mailboxSearchOrder - mailbox search order

Throws:

NullArgumentException - mailboxSearchOrder is null

UnsupportedException - mailboxSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getMailboxSearchRecord

MailboxSearchRecord getMailboxSearchRecord(Type mailboxSearchRecordType)
                                    throws OperationFailedException

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.

Parameters:

mailboxSearchRecordType - a mailbox search record type

Returns:

the mailbox search record

Throws:

NullArgumentException - mailboxSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(mailboxSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.