public interface MailboxSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
MailboxList |
getMailboxes()
Gets the mailbox list resulting from the search.
|
MailboxQueryInspector |
getMailboxQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
MailboxSearchResultsRecord |
getMailboxSearchResultsRecord(Type mailboxSearchRecordType)
Gets the mailbox search results record corresponding to the given
mailbox search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
MailboxList getMailboxes()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. MailboxQueryInspector getMailboxQueryInspector()
mandatory
- This method must be implemented. MailboxSearchResultsRecord getMailboxSearchResultsRecord(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.