org.osid.bidding

Interface AuctionQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidGovernatorQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidSourceableQuery, OsidTemporalQuery, Suppliable

public interface AuctionQuery
extends OsidGovernatorQuery, OsidTemporalQuery

This is the query for searching auctions. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAuctionHouseIdTerms() Clears the auction house Id query terms.
void	clearAuctionHouseTerms() Clears the auction house query terms.
void	clearBidIdTerms() Clears the bid Id query terms.
void	clearBidTerms() Clears the bid query terms.
void	clearBuyoutPriceTerms() Clears the buyout price terms.
void	clearCurrencyTypeTerms() Clears the currency type terms.
void	clearItemIdTerms() Clears the resource Id query terms.
void	clearItemLimitTerms() Clears the item limit terms.
void	clearItemTerms() Clears the seller query terms.
void	clearLotSizeTerms() Clears the lot size terms.
void	clearMinimumBiddersTerms() Clears the minimum bidders terms.
void	clearPriceIncrementTerms() Clears the price increment terms.
void	clearRemainingItemsTerms() Clears the remaining items terms.
void	clearReservePriceTerms() Clears the reserve price terms.
void	clearSealedTerms() Clears the sealed terms.
void	clearSellerIdTerms() Clears the resource Id query terms.
void	clearSellerTerms() Clears the seller query terms.
void	clearStartingPriceTerms() Clears the starting price terms.
AuctionHouseQuery	getAuctionHouseQuery() Gets the query for a auction house.
AuctionQueryRecord	getAuctionQueryRecord(Type auctionRecordType) Gets the auction query record corresponding to the given Auction record Type.
BidQuery	getBidQuery() Gets the query for a bid.
ResourceQuery	getItemQuery() Gets the query for a resource.
ResourceQuery	getSellerQuery() Gets the query for a resource.
void	matchAnyBuyoutPrice(boolean match) Matches auctions with any buyout price.
void	matchAnyCurrencyType(boolean match) Matches auctions with any currency type set.
void	matchAnyItem(boolean match) Matches auctions with any item set.
void	matchAnyItemLimit(boolean match) Matches auctions with any item limit.
void	matchAnyLotSize(boolean match) Matches auctions with any lot size set.
void	matchAnyMinimumBidders(boolean match) Matches auctions with any minimum bidders set.
void	matchAnyPriceIncrement(boolean match) Matches auctions with any price increment.
void	matchAnyReservePrice(boolean match) Matches auctions with any reserve price.
void	matchAnySeller(boolean match) Matches auctions with any seller set.
void	matchAnyStartingPrice(boolean match) Matches auctions with any starting price.
void	matchAuctionHouseId(Id auctionHouseId, boolean match) Sets the auction house Id for this query to match auctions assigned to auction houses.
void	matchBidId(Id bidId, boolean match) Sets the bid Id for this query.
void	matchBuyoutPrice(Currency start, Currency end, boolean match) Matches the buyout price between the given range inclusive.
void	matchCurrencyType(Type currencyType, boolean match) Matches the currency type.
void	matchItemId(Id resourceId, boolean match) Sets the resource Id for this query.
void	matchItemLimit(long start, long end, boolean match) Matches the item limit between the given range inclusive.
void	matchLotSize(long start, long end, boolean match) Matches the lot size between the given range inclusive.
void	matchMinimumBidders(long start, long end, boolean match) Matches the minimum bidders between the given range inclusive.
void	matchPriceIncrement(Currency start, Currency end, boolean match) Matches the price increment between the given range inclusive.
void	matchRemainingItems(long start, long end, boolean match) Matches the remaining items between the given range inclusive.
void	matchReservePrice(Currency start, Currency end, boolean match) Matches the reserve price between the given range inclusive.
void	matchSealed(boolean match) Matches sealed auctions.
void	matchSellerId(Id resourceId, boolean match) Sets the resource Id for this query.
void	matchStartingPrice(Currency start, Currency end, boolean match) Matches the starting price between the given range inclusive.
boolean	supportsAuctionHouseQuery() Tests if an AuctionHouseQuery is available.
boolean	supportsBidQuery() Tests if a BidQuery is available.
boolean	supportsItemQuery() Tests if a ResourceQuery is available.
boolean	supportsSellerQuery() Tests if a ResourceQuery is available.

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidOperableQuery

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Methods inherited from interface org.osid.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Methods inherited from interface org.osid.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchCurrencyType

void matchCurrencyType(Type currencyType,
                     boolean match)

Matches the currency type.

Parameters:

currencyType - a currency type

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - currencyType is null

Compliance:

mandatory - This method must be implemented.

matchAnyCurrencyType

void matchAnyCurrencyType(boolean match)

Matches auctions with any currency type set.

Parameters:

match - true to match auctions with any currency type, false to match auctions with no currency type

Compliance:

mandatory - This method must be implemented.

clearCurrencyTypeTerms

void clearCurrencyTypeTerms()

Clears the currency type terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumBidders

void matchMinimumBidders(long start,
                       long end,
                       boolean match)

Matches the minimum bidders between the given range inclusive.

Parameters:

start - start of range

end - end of range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - start is greater than end

Compliance:

mandatory - This method must be implemented.

matchAnyMinimumBidders

void matchAnyMinimumBidders(boolean match)

Matches auctions with any minimum bidders set.

Parameters:

match - true to match auctions with any minimum bidders, false to match auctions with no minimum bidders

Compliance:

mandatory - This method must be implemented.

clearMinimumBiddersTerms

void clearMinimumBiddersTerms()

Clears the minimum bidders terms.

Compliance:

mandatory - This method must be implemented.

matchSealed

void matchSealed(boolean match)

Matches sealed auctions.

Parameters:

match - true to match sealed auctions, false to match visible bid auctions

Compliance:

mandatory - This method must be implemented.

clearSealedTerms

void clearSealedTerms()

Clears the sealed terms.

Compliance:

mandatory - This method must be implemented.

matchSellerId

void matchSellerId(Id resourceId,
                 boolean match)

Sets the resource Id for this query.

Parameters:

resourceId - the resource Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearSellerIdTerms

void clearSellerIdTerms()

Clears the resource Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsSellerQuery

boolean supportsSellerQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSellerQuery

ResourceQuery getSellerQuery()

Gets the query for a resource. Multiple retrievals produce a nested OR term.

Returns:

the resource query

Throws:

UnimplementedException - supportsSellerQuery() is false

Compliance:

optional - This method must be implemented if supportsSellerQuery() is true.

matchAnySeller

void matchAnySeller(boolean match)

Matches auctions with any seller set.

Parameters:

match - true to match auctions with any seller, false to match auctions with no seller

Compliance:

mandatory - This method must be implemented.

clearSellerTerms

void clearSellerTerms()

Clears the seller query terms.

Compliance:

mandatory - This method must be implemented.

matchItemId

void matchItemId(Id resourceId,
               boolean match)

Sets the resource Id for this query.

Parameters:

resourceId - the resource Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearItemIdTerms

void clearItemIdTerms()

Clears the resource Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsItemQuery

boolean supportsItemQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getItemQuery

ResourceQuery getItemQuery()

Gets the query for a resource. Multiple retrievals produce a nested OR term.

Returns:

the resource query

Throws:

UnimplementedException - supportsItemQuery() is false

Compliance:

optional - This method must be implemented if supportsItemQuery() is true.

matchAnyItem

void matchAnyItem(boolean match)

Matches auctions with any item set.

Parameters:

match - true to match auctions with any item, false to match auctions with no item

Compliance:

mandatory - This method must be implemented.

clearItemTerms

void clearItemTerms()

Clears the seller query terms.

Compliance:

mandatory - This method must be implemented.

matchLotSize

void matchLotSize(long start,
                long end,
                boolean match)

Matches the lot size between the given range inclusive.

Parameters:

start - start of range

end - end of range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - start is greater than end

Compliance:

mandatory - This method must be implemented.

matchAnyLotSize

void matchAnyLotSize(boolean match)

Matches auctions with any lot size set.

Parameters:

match - true to match auctions with any lot size, false to match auctions with no lot size set

Compliance:

mandatory - This method must be implemented.

clearLotSizeTerms

void clearLotSizeTerms()

Clears the lot size terms.

Compliance:

mandatory - This method must be implemented.

matchRemainingItems

void matchRemainingItems(long start,
                       long end,
                       boolean match)

Matches the remaining items between the given range inclusive.

Parameters:

start - start of range

end - end of range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - start is greater than end

Compliance:

mandatory - This method must be implemented.

clearRemainingItemsTerms

void clearRemainingItemsTerms()

Clears the remaining items terms.

Compliance:

mandatory - This method must be implemented.

matchItemLimit

void matchItemLimit(long start,
                  long end,
                  boolean match)

Matches the item limit between the given range inclusive.

Parameters:

start - start of range

end - end of range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - start is greater than end

Compliance:

mandatory - This method must be implemented.

matchAnyItemLimit

void matchAnyItemLimit(boolean match)

Matches auctions with any item limit.

Parameters:

match - true to match auctions with any item limit, false to match auctions with no item limit

Compliance:

mandatory - This method must be implemented.

clearItemLimitTerms

void clearItemLimitTerms()

Clears the item limit terms.

Compliance:

mandatory - This method must be implemented.

matchStartingPrice

void matchStartingPrice(Currency start,
                      Currency end,
                      boolean match)

Matches the starting price between the given range inclusive.

Parameters:

start - start of range

end - end of range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - start is greater than end or start.getCurencyType() != end.getCurrencyType()

NullArgumentException - start or end is null

Compliance:

mandatory - This method must be implemented.

matchAnyStartingPrice

void matchAnyStartingPrice(boolean match)

Matches auctions with any starting price.

Parameters:

match - true to match auctions with any starting price, false to match auctions with no starting price

Compliance:

mandatory - This method must be implemented.

clearStartingPriceTerms

void clearStartingPriceTerms()

Clears the starting price terms.

Compliance:

mandatory - This method must be implemented.

matchPriceIncrement

void matchPriceIncrement(Currency start,
                       Currency end,
                       boolean match)

Matches the price increment between the given range inclusive.

Parameters:

start - start of range

end - end of range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - start is greater than end or start.getCurencyType() != end.getCurrencyType()

NullArgumentException - start or end is null

Compliance:

mandatory - This method must be implemented.

matchAnyPriceIncrement

void matchAnyPriceIncrement(boolean match)

Matches auctions with any price increment.

Parameters:

match - true to match auctions with any price increment, false to match auctions with no price increment

Compliance:

mandatory - This method must be implemented.

clearPriceIncrementTerms

void clearPriceIncrementTerms()

Clears the price increment terms.

Compliance:

mandatory - This method must be implemented.

matchReservePrice

void matchReservePrice(Currency start,
                     Currency end,
                     boolean match)

Matches the reserve price between the given range inclusive.

Parameters:

start - start of range

end - end of range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - start is greater than end or start.getCurencyType() != end.getCurrencyType()

NullArgumentException - start or end is null

Compliance:

mandatory - This method must be implemented.

matchAnyReservePrice

void matchAnyReservePrice(boolean match)

Matches auctions with any reserve price.

Parameters:

match - true to match auctions with any reserve price, false to match auctions with no reserve price

Compliance:

mandatory - This method must be implemented.

clearReservePriceTerms

void clearReservePriceTerms()

Clears the reserve price terms.

Compliance:

mandatory - This method must be implemented.

matchBuyoutPrice

void matchBuyoutPrice(Currency start,
                    Currency end,
                    boolean match)

Matches the buyout price between the given range inclusive.

Parameters:

start - start of range

end - end of range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - start is greater than end or start.getCurencyType() != end.getCurrencyType()

NullArgumentException - start or end is null

Compliance:

mandatory - This method must be implemented.

matchAnyBuyoutPrice

void matchAnyBuyoutPrice(boolean match)

Matches auctions with any buyout price.

Parameters:

match - true to match auctions with any buyout price, false to match auctions with no buyout price

Compliance:

mandatory - This method must be implemented.

clearBuyoutPriceTerms

void clearBuyoutPriceTerms()

Clears the buyout price terms.

Compliance:

mandatory - This method must be implemented.

matchBidId

void matchBidId(Id bidId,
              boolean match)

Sets the bid Id for this query.

Parameters:

bidId - the bid Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - bidId is null

Compliance:

mandatory - This method must be implemented.

clearBidIdTerms

void clearBidIdTerms()

Clears the bid Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsBidQuery

boolean supportsBidQuery()

Tests if a BidQuery is available.

Returns:

true if a bid query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBidQuery

BidQuery getBidQuery()

Gets the query for a bid. Multiple retrievals produce a nested OR term.

Returns:

the bid query

Throws:

UnimplementedException - supportsBidQuery() is false

Compliance:

optional - This method must be implemented if supportsBidQuery() is true.

clearBidTerms

void clearBidTerms()

Clears the bid query terms.

Compliance:

mandatory - This method must be implemented.

matchAuctionHouseId

void matchAuctionHouseId(Id auctionHouseId,
                       boolean match)

Sets the auction house Id for this query to match auctions assigned to auction houses.

Parameters:

auctionHouseId - the auction house Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - auctionHouseId is null

Compliance:

mandatory - This method must be implemented.

clearAuctionHouseIdTerms

void clearAuctionHouseIdTerms()

Clears the auction house Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAuctionHouseQuery

boolean supportsAuctionHouseQuery()

Tests if an AuctionHouseQuery is available.

Returns:

true if a auction house query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAuctionHouseQuery

AuctionHouseQuery getAuctionHouseQuery()

Gets the query for a auction house. Multiple retrievals produce a nested OR term.

Returns:

the auction house query

Throws:

UnimplementedException - supportsAuctionHouseQuery() is false

Compliance:

optional - This method must be implemented if supportsAuctionHouseQuery() is true.

clearAuctionHouseTerms

void clearAuctionHouseTerms()

Clears the auction house query terms.

Compliance:

mandatory - This method must be implemented.

getAuctionQueryRecord

AuctionQueryRecord getAuctionQueryRecord(Type auctionRecordType)
                                         throws OperationFailedException

Gets the auction query record corresponding to the given Auction record Type. Multiple record retrievals produce a nested OR term.

Parameters:

auctionRecordType - an auction record type

Returns:

the auction query record

Throws:

NullArgumentException - auctionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionRecordType) is false

Compliance:

mandatory - This method must be implemented.