Interface BidSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface BidSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
BidQueryInspector	getBidQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
BidList	getBids()	Gets the bid list resulting from a search.
BidSearchResultsRecord	getBidSearchResultsRecord(Type bidSearchRecordType)	Gets the bid search results record corresponding to the given bid 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

getBids

BidList getBids()

Gets the bid list resulting from a search.

Returns:

the bid list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getBidQueryInspector

BidQueryInspector getBidQueryInspector()

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

Returns:

the bid query inspector

Compliance:

mandatory - This method must be implemented.

getBidSearchResultsRecord

BidSearchResultsRecord getBidSearchResultsRecord(Type bidSearchRecordType)
                                          throws OperationFailedException

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

Parameters:

bidSearchRecordType - a bid search record type

Returns:

the bid search results record

Throws:

NullArgumentException - bidSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(bidSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.