Interface MailboxSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface MailboxSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	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 .This method must be used to retrieve an object implementing the requested record interface along with all of its ancestor interfaces.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getMailboxes

MailboxList getMailboxes()

Gets the mailbox list resulting from the search.

Returns:

the mailbox list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getMailboxQueryInspector

MailboxQueryInspector getMailboxQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the mailbox query inspector

Compliance:

mandatory - This method must be implemented.

getMailboxSearchResultsRecord

MailboxSearchResultsRecord getMailboxSearchResultsRecord(Type mailboxSearchRecordType)
                                                  throws OperationFailedException

Gets the mailbox search results 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 results record

Throws:

NullArgumentException - mailboxSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(mailboxSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.