Interface BrokerProcessorSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface BrokerProcessorSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
BrokerProcessorQueryInspector	getBrokerProcessorQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
BrokerProcessorList	getBrokerProcessors()	Gets the broker processor list resulting from a search.
BrokerProcessorSearchResultsRecord	getBrokerProcessorSearchResultsRecord(Type brokerProcessorSearchRecordType)	Gets the broker processor search results record corresponding to the given broker 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

getBrokerProcessors

BrokerProcessorList getBrokerProcessors()

Gets the broker processor list resulting from a search.

Returns:

the broker processor list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getBrokerProcessorQueryInspector

BrokerProcessorQueryInspector getBrokerProcessorQueryInspector()

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

Returns:

the broker processor query inspector

Compliance:

mandatory - This method must be implemented.

getBrokerProcessorSearchResultsRecord

BrokerProcessorSearchResultsRecord getBrokerProcessorSearchResultsRecord(Type brokerProcessorSearchRecordType)
                                                                  throws OperationFailedException

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

Parameters:

brokerProcessorSearchRecordType - a broker processor search record type

Returns:

the broker processor search results record

Throws:

NullArgumentException - brokerProcessorSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.