Interface AuctionConstrainerEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AuctionConstrainerEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
AuctionConstrainerEnablerQueryInspector	getAuctionConstrainerEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
AuctionConstrainerEnablerList	getAuctionConstrainerEnablers()	Gets the AuctionConstrainerEnablerList resulting from a search.
AuctionConstrainerEnablerSearchResultsRecord	getAuctionConstrainerEnablerSearchResultsRecord(Type auctionConstrainerEnablerSearchRecordType)	Gets the auction constrainer enabler search results record corresponding to the given auction constrainer enabler 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

getAuctionConstrainerEnablers

AuctionConstrainerEnablerList getAuctionConstrainerEnablers()

Gets the AuctionConstrainerEnablerList resulting from a search.

Returns:

the auction constrainer enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getAuctionConstrainerEnablerQueryInspector

AuctionConstrainerEnablerQueryInspector getAuctionConstrainerEnablerQueryInspector()

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

Returns:

the auction constrainer enabler query inspector

Compliance:

mandatory - This method must be implemented.

getAuctionConstrainerEnablerSearchResultsRecord

AuctionConstrainerEnablerSearchResultsRecord getAuctionConstrainerEnablerSearchResultsRecord(Type auctionConstrainerEnablerSearchRecordType)
                                                                                      throws OperationFailedException,
PermissionDeniedException

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

Parameters:

auctionConstrainerEnablerSearchRecordType - an auction constrainer enabler search record type

Returns:

the auction constrainer enabler search results record

Throws:

NullArgumentException - auctionConstrainerEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(auctionConstrainerEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.