Interface AuctionConstrainerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AuctionConstrainerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
AuctionConstrainerQueryInspector	getAuctionConstrainerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
AuctionConstrainerList	getAuctionConstrainers()	Gets the AuctionConstrainerList resulting from a search.
AuctionConstrainerSearchResultsRecord	getAuctionConstrainerSearchResultsRecord(Type auctionConstrainerSearchRecordType)	Gets the auction constrainer search results record corresponding to the given auction constrainer 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

getAuctionConstrainers

AuctionConstrainerList getAuctionConstrainers()

Gets the AuctionConstrainerList resulting from a search.

Returns:

the auction constrainer list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getAuctionConstrainerQueryInspector

AuctionConstrainerQueryInspector getAuctionConstrainerQueryInspector()

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

Returns:

the auction constrainer query inspector

Compliance:

mandatory - This method must be implemented.

getAuctionConstrainerSearchResultsRecord

AuctionConstrainerSearchResultsRecord getAuctionConstrainerSearchResultsRecord(Type auctionConstrainerSearchRecordType)
                                                                        throws OperationFailedException,
PermissionDeniedException

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

Parameters:

auctionConstrainerSearchRecordType - an auction constrainer search record type

Returns:

the auction constrainer search results record

Throws:

NullArgumentException - auctionConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(auctionConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.