OSID Logo
OSID Specifications
bidding package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.AuctionQuery
Implementsosid.OsidGovernatorQuery
osid.OsidTemporalQuery
Description

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.

MethodmatchCurrencyType
Description

Matches the currency type.

Parametersosid.type.TypecurrencyTypea currency type
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT currencyType is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyCurrencyType
Description

Matches auctions with any currency type set.

Parametersbooleanmatch true to match auctions with any currency type, false to match auctions with no currency type
CompliancemandatoryThis method must be implemented.
MethodclearCurrencyTypeTerms
Description

Clears the currency type terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMinimumBidders
Description

Matches the minimum bidders between the given range inclusive.

Parameterscardinalstartstart of range
cardinalendend of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT start is greater than end
CompliancemandatoryThis method must be implemented.
MethodmatchAnyMinimumBidders
Description

Matches auctions with any minimum bidders set.

Parametersbooleanmatch true to match auctions with any minimum bidders, false to match auctions with no minimum bidders
CompliancemandatoryThis method must be implemented.
MethodclearMinimumBiddersTerms
Description

Clears the minimum bidders terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSealed
Description

Matches sealed auctions.

Parametersbooleanmatch true to match sealed auctions, false to match visible bid auctions
CompliancemandatoryThis method must be implemented.
MethodclearSealedTerms
Description

Clears the sealed terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSellerId
Description

Sets the resource Id for this query.

Parametersosid.id.IdresourceIdthe resource Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearSellerIdTerms
Description

Clears the resource Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsSellerQuery
Description

Tests if a ResourceQuery is available.

Returnboolean true if a resource query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSellerQuery
Description

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

Returnosid.resource.ResourceQuerythe resource query
ErrorsUNIMPLEMENTED supportsSellerQuery() is false
ComplianceoptionalThis method must be implemented if supportsSellerQuery() is true.
MethodmatchAnySeller
Description

Matches auctions with any seller set.

Parametersbooleanmatch true to match auctions with any seller, false to match auctions with no seller
CompliancemandatoryThis method must be implemented.
MethodclearSellerTerms
Description

Clears the seller query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchItemId
Description

Sets the resource Id for this query.

Parametersosid.id.IdresourceIdthe resource Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearItemIdTerms
Description

Clears the resource Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsItemQuery
Description

Tests if a ResourceQuery is available.

Returnboolean true if a resource query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetItemQuery
Description

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

Returnosid.resource.ResourceQuerythe resource query
ErrorsUNIMPLEMENTED supportsItemQuery() is false
ComplianceoptionalThis method must be implemented if supportsItemQuery() is true.
MethodmatchAnyItem
Description

Matches auctions with any item set.

Parametersbooleanmatch true to match auctions with any item, false to match auctions with no item
CompliancemandatoryThis method must be implemented.
MethodclearItemTerms
Description

Clears the seller query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchLotSize
Description

Matches the lot size between the given range inclusive.

Parameterscardinalstartstart of range
cardinalendend of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT start is greater than end
CompliancemandatoryThis method must be implemented.
MethodmatchAnyLotSize
Description

Matches auctions with any lot size set.

Parametersbooleanmatch true to match auctions with any lot size, false to match auctions with no lot size set
CompliancemandatoryThis method must be implemented.
MethodclearLotSizeTerms
Description

Clears the lot size terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRemainingItems
Description

Matches the remaining items between the given range inclusive.

Parameterscardinalstartstart of range
cardinalendend of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT start is greater than end
CompliancemandatoryThis method must be implemented.
MethodclearRemainingItemsTerms
Description

Clears the remaining items terms.

CompliancemandatoryThis method must be implemented.
MethodmatchItemLimit
Description

Matches the item limit between the given range inclusive.

Parameterscardinalstartstart of range
cardinalendend of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT start is greater than end
CompliancemandatoryThis method must be implemented.
MethodmatchAnyItemLimit
Description

Matches auctions with any item limit.

Parametersbooleanmatch true to match auctions with any item limit, false to match auctions with no item limit
CompliancemandatoryThis method must be implemented.
MethodclearItemLimitTerms
Description

Clears the item limit terms.

CompliancemandatoryThis method must be implemented.
MethodmatchStartingPrice
Description

Matches the starting price between the given range inclusive.

Parametersosid.financials.Currencystartstart of range
osid.financials.Currencyendend of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT start is greater than end or start.getCurencyType() != end.getCurrencyType()
NULL_ARGUMENT start or end is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyStartingPrice
Description

Matches auctions with any starting price.

Parametersbooleanmatch true to match auctions with any starting price, false to match auctions with no starting price
CompliancemandatoryThis method must be implemented.
MethodclearStartingPriceTerms
Description

Clears the starting price terms.

CompliancemandatoryThis method must be implemented.
MethodmatchPriceIncrement
Description

Matches the price increment between the given range inclusive.

Parametersosid.financials.Currencystartstart of range
osid.financials.Currencyendend of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT start is greater than end or start.getCurencyType() != end.getCurrencyType()
NULL_ARGUMENT start or end is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyPriceIncrement
Description

Matches auctions with any price increment.

Parametersbooleanmatch true to match auctions with any price increment, false to match auctions with no price increment
CompliancemandatoryThis method must be implemented.
MethodclearPriceIncrementTerms
Description

Clears the price increment terms.

CompliancemandatoryThis method must be implemented.
MethodmatchReservePrice
Description

Matches the reserve price between the given range inclusive.

Parametersosid.financials.Currencystartstart of range
osid.financials.Currencyendend of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT start is greater than end or start.getCurencyType() != end.getCurrencyType()
NULL_ARGUMENT start or end is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyReservePrice
Description

Matches auctions with any reserve price.

Parametersbooleanmatch true to match auctions with any reserve price, false to match auctions with no reserve price
CompliancemandatoryThis method must be implemented.
MethodclearReservePriceTerms
Description

Clears the reserve price terms.

CompliancemandatoryThis method must be implemented.
MethodmatchBuyoutPrice
Description

Matches the buyout price between the given range inclusive.

Parametersosid.financials.Currencystartstart of range
osid.financials.Currencyendend of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT start is greater than end or start.getCurencyType() != end.getCurrencyType()
NULL_ARGUMENT start or end is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyBuyoutPrice
Description

Matches auctions with any buyout price.

Parametersbooleanmatch true to match auctions with any buyout price, false to match auctions with no buyout price
CompliancemandatoryThis method must be implemented.
MethodclearBuyoutPriceTerms
Description

Clears the buyout price terms.

CompliancemandatoryThis method must be implemented.
MethodmatchBidId
Description

Sets the bid Id for this query.

Parametersosid.id.IdbidIdthe bid Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT bidId is null
CompliancemandatoryThis method must be implemented.
MethodclearBidIdTerms
Description

Clears the bid Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsBidQuery
Description

Tests if a BidQuery is available.

Returnboolean true if a bid query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBidQuery
Description

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

Returnosid.bidding.BidQuerythe bid query
ErrorsUNIMPLEMENTED supportsBidQuery() is false
ComplianceoptionalThis method must be implemented if supportsBidQuery() is true.
MethodclearBidTerms
Description

Clears the bid query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAuctionHouseId
Description

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

Parametersosid.id.IdauctionHouseIdthe auction house Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT auctionHouseId is null
CompliancemandatoryThis method must be implemented.
MethodclearAuctionHouseIdTerms
Description

Clears the auction house Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAuctionHouseQuery
Description

Tests if an AuctionHouseQuery is available.

Returnboolean true if a auction house query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAuctionHouseQuery
Description

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

Returnosid.bidding.AuctionHouseQuerythe auction house query
ErrorsUNIMPLEMENTED supportsAuctionHouseQuery() is false
ComplianceoptionalThis method must be implemented if supportsAuctionHouseQuery() is true.
MethodclearAuctionHouseTerms
Description

Clears the auction house query terms.

CompliancemandatoryThis method must be implemented.
MethodgetAuctionQueryRecord
Description

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

Parametersosid.type.TypeauctionRecordTypean auction record type
Returnosid.bidding.records.AuctionQueryRecordthe auction query record
ErrorsNULL_ARGUMENT auctionRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(auctionRecordType) is false
CompliancemandatoryThis method must be implemented.