OSID Logo
OSID Specifications
bidding package
Version 3.0.0
Release Candidate Preview
Interfaceosid.bidding.BidQuery
Implementsosid.OsidRelationshipQuery
Description

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

MethodmatchAuctionId
Description

Sets the auction Id for this query.

Parametersosid.id.IdauctionIdthe auction Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT auctionId is null
CompliancemandatoryThis method must be implemented.
MethodclearAuctionIdTerms
Description

Clears the auction Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAuctionQuery
Description

Tests if an AuctionQuery is available.

Returnboolean true if an auction query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAuctionQuery
Description

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

Returnosid.bidding.AuctionQuerythe auction query
ErrorsUNIMPLEMENTED supportsAuctionQuery() is false
ComplianceoptionalThis method must be implemented if supportsAuctionQuery() is true.
MethodclearAuctionTerms
Description

Clears the auction query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchBidderId
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.
MethodclearBidderIdTerms
Description

Clears the resource Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsBidderQuery
Description

Tests if a ResourceQuery is available.

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

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

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

Clears the resource query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchBiddingAgentId
Description

Sets the agent Id for this query.

Parametersosid.id.IdagentIdthe agent Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT agentId is null
CompliancemandatoryThis method must be implemented.
MethodclearBiddingAgentIdTerms
Description

Clears the agent Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsBiddingAgentQuery
Description

Tests if an AgentQuery is available.

Returnboolean true if an agent query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBiddingAgentQuery
Description

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

Returnosid.authentication.AgentQuerythe agent query
ErrorsUNIMPLEMENTED supportsBiddingAgentQuery() is false
ComplianceoptionalThis method must be implemented if supportsBiddingAgentQuery() is true.
MethodclearBiddingAgentTerms
Description

Clears the agent query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchQuantity
Description

Matches bids with quantities between the given range inclusive.

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

Clears the quantity query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCurrentBid
Description

Matches bids with a current bidsbetween the given range inclusive.

Parametersosid.financials.Currencystartstart range
osid.financials.Currencyendend 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 currency is null
CompliancemandatoryThis method must be implemented.
MethodclearCurrentBidTerms
Description

Clears the current bid query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMaximumBid
Description

Matches bids with a max bid between the given range inclusive.

Parametersosid.financials.Currencystartstart range
osid.financials.Currencyendend 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 currency is null
CompliancemandatoryThis method must be implemented.
MethodclearMaximumBidTerms
Description

Clears the max bid query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchWinner
Description

Matches winning bids.

Parametersbooleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearWinnerTerms
Description

Clears the winner query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSettlementAmount
Description

Matches bids with a settlement amount between the given range inclusive.

Parametersosid.financials.Currencystartstart range
osid.financials.Currencyendend 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 currency is null
CompliancemandatoryThis method must be implemented.
MethodclearSettlementAmountTerms
Description

Clears the settlement amount query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAuctionHouseId
Description

Sets the auction house Id for this query to match bids 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 a 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.
MethodgetBidQueryRecord
Description

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

Parametersosid.type.TypebidRecordTypea bid record type
Returnosid.bidding.records.BidQueryRecordthe bid query record
ErrorsNULL_ARGUMENT bidRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(bidRecordType) is false
CompliancemandatoryThis method must be implemented.