Interface DispatchSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface DispatchSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
DispatchList	getDispatches()	Gets the dispatch list resulting from a search.
DispatchQueryInspector	getDispatchQueryInspector()	Gets the inspector for the query to examine the terns used in the search.
DispatchSearchResultsRecord	getDispatchSearchResultsRecord(Type dispatchSearchRecordType)	Gets the dispatch search results record corresponding to the given dispatch search record Type.

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

getDispatches

DispatchList getDispatches()

Gets the dispatch list resulting from a search.

Returns:

the dispatch list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getDispatchQueryInspector

DispatchQueryInspector getDispatchQueryInspector()

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

Returns:

the query inspector

Compliance:

mandatory - This method must be implemented.

getDispatchSearchResultsRecord

DispatchSearchResultsRecord getDispatchSearchResultsRecord(Type dispatchSearchRecordType)
                                                    throws OperationFailedException

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

Parameters:

dispatchSearchRecordType - a dispatch search record type

Returns:

the dispatch search results record

Throws:

NullArgumentException - DispatchSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(dispatchSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.