Interface BrokerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface BrokerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
BrokerQueryInspector	getBrokerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
BrokerList	getBrokers()	Gets the broker list resulting from a search.
BrokerSearchResultsRecord	getBrokerSearchResultsRecord(Type brokerSearchRecordType)	Gets the broker search results record corresponding to the given broker 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

getBrokers

BrokerList getBrokers()

Gets the broker list resulting from a search.

Returns:

the broker list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getBrokerQueryInspector

BrokerQueryInspector getBrokerQueryInspector()

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

Returns:

the broker query inspector

Compliance:

mandatory - This method must be implemented.

getBrokerSearchResultsRecord

BrokerSearchResultsRecord getBrokerSearchResultsRecord(Type brokerSearchRecordType)
                                                throws OperationFailedException

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

Parameters:

brokerSearchRecordType - a broker search record type

Returns:

the broker search results record

Throws:

NullArgumentException - brokerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.