org.osid.bidding

Interface AuctionHouseQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface AuctionHouseQuery
extends OsidCatalogQuery

This is the query for searching auction houses. 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	clearAncestorAuctionHouseIdTerms() Clears the ancestor auction house Id query terms.
void	clearAncestorAuctionHouseTerms() Clears the ancestor auction house query terms.
void	clearAuctionIdTerms() Clears the auction Id query terms.
void	clearAuctionTerms() Clears the auction query terms.
void	clearBidIdTerms() Clears the bid Id query terms.
void	clearBidTerms() Clears the bid query terms.
void	clearDescendantAuctionHouseIdTerms() Clears the descendant auction house Id query terms.
void	clearDescendantAuctionHouseTerms() Clears the descendant auction house query terms.
AuctionHouseQuery	getAncestorAuctionHouseQuery() Gets the query for an AuctionHouse.
AuctionHouseQueryRecord	getAuctionHouseQueryRecord(Type auctionHouseRecordType) Gets the auction house query record corresponding to the given AuctionHouse record Type.
AuctionQuery	getAuctionQuery() Gets the query for an auction.
BidQuery	getBidQuery() Gets the query for a bid.
AuctionHouseQuery	getDescendantAuctionHouseQuery() Gets the query for an auction house.
void	matchAncestorAuctionHouseId(Id auctionHouseId, boolean match) Sets the auction house Id for this query to match auction houses that have the specified auction house as an ancestor.
void	matchAnyAncestorAuctionHouse(boolean match) Matches auction houses with any ancestor.
void	matchAnyAuction(boolean match) Matches auction houses with any auction.
void	matchAnyBid(boolean match) Matches auction houses that have any bid.
void	matchAnyDescendantAuctionHouse(boolean match) Matches auction houses with any descendant.
void	matchAuctionId(Id auctionId, boolean match) Sets the auction Id for this query.
void	matchBidId(Id bidId, boolean match) Sets the bid Id for this query.
void	matchDescendantAuctionHouseId(Id auctionHouseId, boolean match) Sets the auction house Id for this query to match auction houses that have the specified auction house as a descendant.
boolean	supportsAncestorAuctionHouseQuery() Tests if an AuctionHouseQuery is available.
boolean	supportsAuctionQuery() Tests if an AuctionQuery is available.
boolean	supportsBidQuery() Tests if a BidQuery is available.
boolean	supportsDescendantAuctionHouseQuery() Tests if an AuctionHouseQuery 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.OsidSourceableQuery

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

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.

matchAnyAuction

void matchAnyAuction(boolean match)

Matches auction houses with any auction.

Parameters:

match - true to match auction houses with any auction, false to match auction houses with no auction

Compliance:

mandatory - This method must be implemented.

clearAuctionTerms

void clearAuctionTerms()

Clears the auction query 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.

matchAnyBid

void matchAnyBid(boolean match)

Matches auction houses that have any bid.

Parameters:

match - true to match auction houses with any bid, false to match auction houses with no bid

Compliance:

mandatory - This method must be implemented.

clearBidTerms

void clearBidTerms()

Clears the bid query terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorAuctionHouseId

void matchAncestorAuctionHouseId(Id auctionHouseId,
                               boolean match)

Sets the auction house Id for this query to match auction houses that have the specified auction house as an ancestor.

Parameters:

auctionHouseId - an 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.

clearAncestorAuctionHouseIdTerms

void clearAncestorAuctionHouseIdTerms()

Clears the ancestor auction house Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorAuctionHouseQuery

boolean supportsAncestorAuctionHouseQuery()

Tests if an AuctionHouseQuery is available.

Returns:

true if an auction house query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorAuctionHouseQuery

AuctionHouseQuery getAncestorAuctionHouseQuery()

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

Returns:

the auction house query

Throws:

UnimplementedException - supportsAncestorAuctionHouseQuery() is false

Compliance:

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

matchAnyAncestorAuctionHouse

void matchAnyAncestorAuctionHouse(boolean match)

Matches auction houses with any ancestor.

Parameters:

match - true to match auction houses with any ancestor, false to match root auction houses

Compliance:

mandatory - This method must be implemented.

clearAncestorAuctionHouseTerms

void clearAncestorAuctionHouseTerms()

Clears the ancestor auction house query terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantAuctionHouseId

void matchDescendantAuctionHouseId(Id auctionHouseId,
                                 boolean match)

Sets the auction house Id for this query to match auction houses that have the specified auction house as a descendant.

Parameters:

auctionHouseId - an 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.

clearDescendantAuctionHouseIdTerms

void clearDescendantAuctionHouseIdTerms()

Clears the descendant auction house Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantAuctionHouseQuery

boolean supportsDescendantAuctionHouseQuery()

Tests if an AuctionHouseQuery is available.

Returns:

true if an auction house query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantAuctionHouseQuery

AuctionHouseQuery getDescendantAuctionHouseQuery()

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

Returns:

the auction house query

Throws:

UnimplementedException - supportsDescendantAuctionHouseQuery() is false

Compliance:

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

matchAnyDescendantAuctionHouse

void matchAnyDescendantAuctionHouse(boolean match)

Matches auction houses with any descendant.

Parameters:

match - true to match auction houses with any descendant, false to match leaf auction houses

Compliance:

mandatory - This method must be implemented.

clearDescendantAuctionHouseTerms

void clearDescendantAuctionHouseTerms()

Clears the descendant auction house query terms.

Compliance:

mandatory - This method must be implemented.

getAuctionHouseQueryRecord

AuctionHouseQueryRecord getAuctionHouseQueryRecord(Type auctionHouseRecordType)
                                                   throws OperationFailedException

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

Parameters:

auctionHouseRecordType - an auction house record type

Returns:

the auction house query record

Throws:

NullArgumentException - auctionHouseRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionHouseRecordType) is false

Compliance:

mandatory - This method must be implemented.