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

Modifier and Type	Method	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 an 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 .Multiple record retrievals produce a nested OR term.
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 an 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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Modifier and Type	Method	Description
void	clearEndReasonIdTerms()	Clears all state Id terms.
void	clearEndReasonTerms()	Clears all end reason state terms.
StateQuery	getEndReasonQuery(boolean match)	Gets the query for the end reason state.
void	matchAnyEndReason(boolean match)	Match any end reason state.
void	matchEndReasonId(Id stateId, boolean match)	Match the Id of the end reason state.
boolean	supportsEndReasonQuery()	Tests if a StateQuery for the end reason is available.

Methods inherited from interface OsidTemporalQuery

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

Modifier and Type	Method	Description
void	clearDateTerms()	Clears the date query terms.
void	clearEffectiveTerms()	Clears the effective query terms.
void	clearEndDateTerms()	Clears the end date query terms.
void	clearStartDateTerms()	Clears the start date query terms.
void	matchAnyEndDate(boolean match)	Matches temporals with any end date set.
void	matchAnyStartDate(boolean match)	Matches temporals with any start date set.
void	matchDate(DateTime from, DateTime to, boolean match)	Matches temporals where the given date range falls entirely between the start and end dates inclusive.
void	matchEffective(boolean match)	Match effective objects where the current date falls within the start and end dates inclusive.
void	matchEndDate(DateTime start, DateTime end, boolean match)	Matches temporals whose effective end date falls in between the given dates inclusive.
void	matchStartDate(DateTime start, DateTime end, boolean match)	Matches temporals whose start date falls in between the given dates inclusive.

Method Details

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 {@code supportsAuctionQuery()} is {@code 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 {@code supportsBidderQuery()} is {@code 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 {@code supportsBiddingAgentQuery()} is {@code 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 an AuctionHouseQuery is available.

Returns:

true if an auction house query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAuctionHouseQuery

AuctionHouseQuery getAuctionHouseQuery()

Gets the query for an 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 {@code supportsAuctionHouseQuery()} is {@code 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.