org.osid.bidding

Interface BidQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable

public interface BidQuery
extends OsidRelationshipQuery

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.

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	clearAuctionIdTerms() Clears the auction Id query terms.
void	clearAuctionTerms() Clears the auction query terms.
void	clearBidderIdTerms() Clears the resource Id query terms.
void	clearBidderTerms() Clears the resource query terms.
void	clearBiddingAgentIdTerms() Clears the agent Id query terms.
void	clearBiddingAgentTerms() Clears the agent query terms.
void	clearCurrentBidTerms() Clears the current bid query terms.
void	clearMaximumBidTerms() Clears the max bid query terms.
void	clearQuantityTerms() Clears the quantity query terms.
void	clearSettlementAmountTerms() Clears the settlement amount query terms.
void	clearWinnerTerms() Clears the winner query terms.
AuctionHouseQuery	getAuctionHouseQuery() Gets the query for a auction house.
AuctionQuery	getAuctionQuery() Gets the query for an auction.
ResourceQuery	getBidderQuery() Gets the query for a resource.
AgentQuery	getBiddingAgentQuery() Gets the query for an agent.
BidQueryRecord	getBidQueryRecord(Type bidRecordType) Gets the bid query record corresponding to the given Bid record Type.
void	matchAuctionHouseId(Id auctionHouseId, boolean match) Sets the auction house Id for this query to match bids assigned to auction houses.
void	matchAuctionId(Id auctionId, boolean match) Sets the auction Id for this query.
void	matchBidderId(Id resourceId, boolean match) Sets the resource Id for this query.
void	matchBiddingAgentId(Id agentId, boolean match) Sets the agent Id for this query.
void	matchCurrentBid(Currency start, Currency end, boolean match) Matches bids with a current bidsbetween the given range inclusive.
void	matchMaximumBid(Currency start, Currency end, boolean match) Matches bids with a max bid between the given range inclusive.
void	matchQuantity(long start, long end, boolean match) Matches bids with quantities between the given range inclusive.
void	matchSettlementAmount(Currency start, Currency end, boolean match) Matches bids with a settlement amount between the given range inclusive.
void	matchWinner(boolean match) Matches winning bids.
boolean	supportsAuctionHouseQuery() Tests if a AuctionHouseQuery is available.
boolean	supportsAuctionQuery() Tests if an AuctionQuery is available.
boolean	supportsBidderQuery() Tests if a ResourceQuery is available.
boolean	supportsBiddingAgentQuery() Tests if an AgentQuery is available.

Methods inherited from interface org.osid.OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

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.OsidTemporalQuery

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

Method Detail

matchAuctionId

void matchAuctionId(Id auctionId,
                  boolean match)

Sets the auction Id for this query.

Parameters:

auctionId - the auction Id

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

Throws:

NullArgumentException - auctionId is null

Compliance:

mandatory - This method must be implemented.

clearAuctionIdTerms

void clearAuctionIdTerms()

Clears the auction Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAuctionQuery

boolean supportsAuctionQuery()

Tests if an AuctionQuery is available.

Returns:

true if an auction query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAuctionQuery

AuctionQuery getAuctionQuery()

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

Returns:

the auction query

Throws:

UnimplementedException - supportsAuctionQuery() is false

Compliance:

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

clearAuctionTerms

void clearAuctionTerms()

Clears the auction query terms.

Compliance:

mandatory - This method must be implemented.

matchBidderId

void matchBidderId(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.

clearBidderIdTerms

void clearBidderIdTerms()

Clears the resource Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsBidderQuery

boolean supportsBidderQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBidderQuery

ResourceQuery getBidderQuery()

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

Returns:

the resource query

Throws:

UnimplementedException - supportsBidderQuery() is false

Compliance:

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

clearBidderTerms

void clearBidderTerms()

Clears the resource query terms.

Compliance:

mandatory - This method must be implemented.

matchBiddingAgentId

void matchBiddingAgentId(Id agentId,
                       boolean match)

Sets the agent Id for this query.

Parameters:

agentId - the agent Id

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

Throws:

NullArgumentException - agentId is null

Compliance:

mandatory - This method must be implemented.

clearBiddingAgentIdTerms

void clearBiddingAgentIdTerms()

Clears the agent Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsBiddingAgentQuery

boolean supportsBiddingAgentQuery()

Tests if an AgentQuery is available.

Returns:

true if an agent query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBiddingAgentQuery

AgentQuery getBiddingAgentQuery()

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

Returns:

the agent query

Throws:

UnimplementedException - supportsBiddingAgentQuery() is false

Compliance:

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

clearBiddingAgentTerms

void clearBiddingAgentTerms()

Clears the agent query terms.

Compliance:

mandatory - This method must be implemented.

matchQuantity

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

Matches bids with quantities between the given range inclusive.

Parameters:

start - start range

end - end 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.

clearQuantityTerms

void clearQuantityTerms()

Clears the quantity query terms.

Compliance:

mandatory - This method must be implemented.

matchCurrentBid

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

Matches bids with a current bidsbetween the given range inclusive.

Parameters:

start - start range

end - end 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 - currency is null

Compliance:

mandatory - This method must be implemented.

clearCurrentBidTerms

void clearCurrentBidTerms()

Clears the current bid query terms.

Compliance:

mandatory - This method must be implemented.

matchMaximumBid

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

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

Parameters:

start - start range

end - end 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 - currency is null

Compliance:

mandatory - This method must be implemented.

clearMaximumBidTerms

void clearMaximumBidTerms()

Clears the max bid query terms.

Compliance:

mandatory - This method must be implemented.

matchWinner

void matchWinner(boolean match)

Matches winning bids.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearWinnerTerms

void clearWinnerTerms()

Clears the winner query terms.

Compliance:

mandatory - This method must be implemented.

matchSettlementAmount

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

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

Parameters:

start - start range

end - end 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 - currency is null

Compliance:

mandatory - This method must be implemented.

clearSettlementAmountTerms

void clearSettlementAmountTerms()

Clears the settlement amount 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 bids 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 a 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.

getBidQueryRecord

BidQueryRecord getBidQueryRecord(Type bidRecordType)
                                 throws OperationFailedException

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

Parameters:

bidRecordType - a bid record type

Returns:

the bid query record

Throws:

NullArgumentException - bidRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(bidRecordType) is false

Compliance:

mandatory - This method must be implemented.