org.osid.bidding

Interface AuctionQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidGovernatorQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector, OsidTemporalQueryInspector

public interface AuctionQueryInspector
extends OsidGovernatorQueryInspector, OsidTemporalQueryInspector

This is the query inspector for examining auction queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAuctionHouseIdTerms() Gets the auction house Id query terms.
AuctionHouseQueryInspector[]	getAuctionHouseTerms() Gets the auction house query terms.
AuctionQueryInspectorRecord	getAuctionQueryInspectorRecord(Type auctionRecordType) Gets the auction query inspector record corresponding to the given Auction record Type.
IdTerm[]	getBidIdTerms() Gets the bid Id query terms.
BidQueryInspector[]	getBidTerms() Gets the bid query terms.
CurrencyRangeTerm[]	getBuyoutPriceTerms() Gets the buyout price query terms.
TypeTerm[]	getCurrencyTypeTerms() Gets the currency type query terms.
IdTerm[]	getItemIdTerms() Gets the item Id query terms.
CardinalRangeTerm[]	getItemLimitTerms() Gets the items limit query terms.
ResourceQueryInspector[]	getItemTerms() Gets the item query terms.
CardinalRangeTerm[]	getLotSizeTerms() Gets the lot size query terms.
CardinalRangeTerm[]	getMinimumBiddersTerms() Gets the minimum bidders query terms.
CurrencyRangeTerm[]	getPriceIncrementTerms() Gets the price increment query terms.
CardinalRangeTerm[]	getRemainingItemsTerms() Gets the remaining items query terms.
CurrencyRangeTerm[]	getReservePriceTerms() Gets the reserve price query terms.
BooleanTerm[]	getSealedTerms() Gets the sealed auctions query terms.
IdTerm[]	getSellerIdTerms() Gets the seller Id query terms.
ResourceQueryInspector[]	getSellerTerms() Gets the seller query terms.
CurrencyRangeTerm[]	getStartingPriceTerms() Gets the starting price query terms.

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Methods inherited from interface org.osid.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getCurrencyTypeTerms

TypeTerm[] getCurrencyTypeTerms()

Gets the currency type query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getMinimumBiddersTerms

CardinalRangeTerm[] getMinimumBiddersTerms()

Gets the minimum bidders query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSealedTerms

BooleanTerm[] getSealedTerms()

Gets the sealed auctions query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSellerIdTerms

IdTerm[] getSellerIdTerms()

Gets the seller Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSellerTerms

ResourceQueryInspector[] getSellerTerms()

Gets the seller query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getItemIdTerms

IdTerm[] getItemIdTerms()

Gets the item Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getItemTerms

ResourceQueryInspector[] getItemTerms()

Gets the item query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getLotSizeTerms

CardinalRangeTerm[] getLotSizeTerms()

Gets the lot size query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRemainingItemsTerms

CardinalRangeTerm[] getRemainingItemsTerms()

Gets the remaining items query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getItemLimitTerms

CardinalRangeTerm[] getItemLimitTerms()

Gets the items limit query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getStartingPriceTerms

CurrencyRangeTerm[] getStartingPriceTerms()

Gets the starting price query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getPriceIncrementTerms

CurrencyRangeTerm[] getPriceIncrementTerms()

Gets the price increment query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getReservePriceTerms

CurrencyRangeTerm[] getReservePriceTerms()

Gets the reserve price query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getBuyoutPriceTerms

CurrencyRangeTerm[] getBuyoutPriceTerms()

Gets the buyout price query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getBidIdTerms

IdTerm[] getBidIdTerms()

Gets the bid Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getBidTerms

BidQueryInspector[] getBidTerms()

Gets the bid query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAuctionHouseIdTerms

IdTerm[] getAuctionHouseIdTerms()

Gets the auction house Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAuctionHouseTerms

AuctionHouseQueryInspector[] getAuctionHouseTerms()

Gets the auction house query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAuctionQueryInspectorRecord

AuctionQueryInspectorRecord getAuctionQueryInspectorRecord(Type auctionRecordType)
                                                           throws OperationFailedException

Gets the auction query inspector record corresponding to the given Auction record Type.

Parameters:

auctionRecordType - an auction record type

Returns:

the auction query inspector record

Throws:

NullArgumentException - auctionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionRecordType) is false

Compliance:

mandatory - This method must be implemented.