public interface MailboxSearch extends OsidSearch
The interface for governing mailbox searches.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongMailboxes(IdList mailboxIds)
mailboxIds
- list of mailboxesNullArgumentException
- mailboxIds
is
null
mandatory
- This method must be implemented. void orderMailboxResults(MailboxSearchOrder mailboxSearchOrder)
mailboxSearchOrder
- mailbox search orderNullArgumentException
- mailboxSearchOrder
is null
UnsupportedException
- mailboxSearchOrder
is not of this servicemandatory
- This method must be implemented. MailboxSearchRecord getMailboxSearchRecord(Type mailboxSearchRecordType) throws OperationFailedException
Type.
This method must be used to
retrieve an object implementing the requested record interface along
with all of its ancestor interfaces.mailboxSearchRecordType
- a mailbox search record typeNullArgumentException
- mailboxSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(mailboxSearchRecordType)
is false
mandatory
- This method must be implemented.