Interface DispatchProcessorSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface DispatchProcessorSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
DispatchProcessorQueryInspector	getDispatchProcessorQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
DispatchProcessorList	getDispatchProcessors()	Gets the dispatch processor list resulting from a search.
DispatchProcessorSearchResultsRecord	getDispatchProcessorSearchResultsRecord(Type dispatchProcessorSearchRecordType)	Gets the dispatch processor search results record corresponding to the given dispatch processor 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

getDispatchProcessors

DispatchProcessorList getDispatchProcessors()

Gets the dispatch processor list resulting from a search.

Returns:

the dispatch processor list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getDispatchProcessorQueryInspector

DispatchProcessorQueryInspector getDispatchProcessorQueryInspector()

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

Returns:

the dispatch processor query inspector

Compliance:

mandatory - This method must be implemented.

getDispatchProcessorSearchResultsRecord

DispatchProcessorSearchResultsRecord getDispatchProcessorSearchResultsRecord(Type dispatchProcessorSearchRecordType)
                                                                      throws OperationFailedException

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

Parameters:

dispatchProcessorSearchRecordType - a dispatch processor search record type

Returns:

the dispatch processor search results record

Throws:

NullArgumentException - dispatchProcessorSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(dispatchProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.