Interface BidEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface BidEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
BidEnablerQueryInspector	getBidEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
BidEnablerList	getBidEnablers()	Gets the bid enabler list resulting from a search.
BidEnablerSearchResultsRecord	getBidEnablerSearchResultsRecord(Type bidEnablerSearchRecordType)	Gets the bid enabler search results record corresponding to the given bid enabler 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

getBidEnablers

BidEnablerList getBidEnablers()

Gets the bid enabler list resulting from a search.

Returns:

the bid enabler list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getBidEnablerQueryInspector

BidEnablerQueryInspector getBidEnablerQueryInspector()

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

Returns:

the bid enabler query inspector

Compliance:

mandatory - This method must be implemented.

getBidEnablerSearchResultsRecord

BidEnablerSearchResultsRecord getBidEnablerSearchResultsRecord(Type bidEnablerSearchRecordType)
                                                        throws OperationFailedException

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

Parameters:

bidEnablerSearchRecordType - a bid enabler search record type

Returns:

the bid enabler search results record

Throws:

NullArgumentException - bidEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(bidEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.