org.osid.bidding.rules

Interface AuctionConstrainerQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidConstrainerQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, Suppliable

public interface AuctionConstrainerQuery
extends OsidConstrainerQuery

This is the query for searching auction constrainers. 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	clearRuledAuctionIdTerms() Clears the auction Id query terms.
void	clearRuledAuctionTerms() Clears the auction query terms.
AuctionConstrainerQueryRecord	getAuctionConstrainerQueryRecord(Type auctionConstrainerRecordType) Gets the auction constrainer query record corresponding to the given AuctionConstrainer record Type.
AuctionHouseQuery	getAuctionHouseQuery() Gets the query for a auction house.
AuctionQuery	getRuledAuctionQuery() Gets the query for an auction.
void	matchAnyRuledAuction(boolean match) Matches mapped to any auction.
void	matchAuctionHouseId(Id auctionHouseId, boolean match) Matches mapped to the auction house.
void	matchRuledAuctionId(Id auctionId, boolean match) Matches mapped to the auction.
boolean	supportsAuctionHouseQuery() Tests if a AuctionHouseQuery is available.
boolean	supportsRuledAuctionQuery() Tests if an AuctionQuery is available.

Methods inherited from interface org.osid.OsidRuleQuery

clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery

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

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Method Detail

matchRuledAuctionId

void matchRuledAuctionId(Id auctionId,
                       boolean match)

Matches mapped to the auction.

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.

clearRuledAuctionIdTerms

void clearRuledAuctionIdTerms()

Clears the auction Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledAuctionQuery

boolean supportsRuledAuctionQuery()

Tests if an AuctionQuery is available.

Returns:

true if an auction query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledAuctionQuery

AuctionQuery getRuledAuctionQuery()

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

Returns:

the auction query

Throws:

UnimplementedException - supportsRuledAuctionQuery() is false

Compliance:

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

matchAnyRuledAuction

void matchAnyRuledAuction(boolean match)

Matches mapped to any auction.

Parameters:

match - true for mapped to any auction, false to match mapped to no auction

Compliance:

mandatory - This method must be implemented.

clearRuledAuctionTerms

void clearRuledAuctionTerms()

Clears the auction query terms.

Compliance:

mandatory - This method must be implemented.

matchAuctionHouseId

void matchAuctionHouseId(Id auctionHouseId,
                       boolean match)

Matches mapped to the auction house.

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.

getAuctionConstrainerQueryRecord

AuctionConstrainerQueryRecord getAuctionConstrainerQueryRecord(Type auctionConstrainerRecordType)
                                                               throws OperationFailedException

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

Parameters:

auctionConstrainerRecordType - an auction constrainer record type

Returns:

the auction constrainer query record

Throws:

NullArgumentException - auctionConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.