Interface MessageSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface MessageSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
MessageQueryInspector	getMessageQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
MessageList	getMessages()	Gets the message list resulting from a search.
MessageSearchResultsRecord	getMessageSearchResultsRecord(Type messageSearchRecordType)	Gets the message search results record corresponding to the given message search record Type .This method is used to retrieve an object implementing the requested record.

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

getMessages

MessageList getMessages()

Gets the message list resulting from a search.

Returns:

the message list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getMessageQueryInspector

MessageQueryInspector getMessageQueryInspector()

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

Returns:

the message query inspector

Compliance:

mandatory - This method must be implemented.

getMessageSearchResultsRecord

MessageSearchResultsRecord getMessageSearchResultsRecord(Type messageSearchRecordType)
                                                  throws OperationFailedException

Gets the message search results record corresponding to the given message search record Type .This method is used to retrieve an object implementing the requested record.

Parameters:

messageSearchRecordType - a message search record type

Returns:

the message search results record

Throws:

NullArgumentException - messageSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordTypeType(messageSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.