public interface BidSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and 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. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
BidList getBids()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. BidQueryInspector getBidQueryInspector()
mandatory
- This method must be implemented. BidSearchResultsRecord getBidSearchResultsRecord(Type bidSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.bidSearchRecordType
- a bid search record typeNullArgumentException
- bidSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(bidSearchRecordType)
is false
mandatory
- This method must be implemented.