Interface AuctionProcessorSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AuctionProcessorSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
AuctionProcessorQueryInspector	getAuctionProcessorQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
AuctionProcessorList	getAuctionProcessors()	Gets the AuctionProcessorList resulting from a search.
AuctionProcessorSearchResultsRecord	getAuctionProcessorSearchResultsRecord(Type auctionProcessorSearchRecordType)	Gets the auction processor search results record corresponding to the given auction 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

getAuctionProcessors

AuctionProcessorList getAuctionProcessors()

Gets the AuctionProcessorList resulting from a search.

Returns:

the auction processor list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getAuctionProcessorQueryInspector

AuctionProcessorQueryInspector getAuctionProcessorQueryInspector()

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

Returns:

the auction processor query inspector

Compliance:

mandatory - This method must be implemented.

getAuctionProcessorSearchResultsRecord

AuctionProcessorSearchResultsRecord getAuctionProcessorSearchResultsRecord(Type auctionProcessorSearchRecordType)
                                                                    throws OperationFailedException,
PermissionDeniedException

Gets the auction processor search results record corresponding to the given auction processor search record Type . This method must be used to retrieve an object implementing the requested record.

Parameters:

auctionProcessorSearchRecordType - an auction processor search record type

Returns:

the auction processor search results record

Throws:

NullArgumentException - auctionProcessorSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(auctionProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.