org.osid.bidding.rules

Interface AuctionConstrainerEnablerQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidEnablerQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, OsidTemporalQuery, Suppliable

public interface AuctionConstrainerEnablerQuery
extends OsidEnablerQuery

This is the query for searching auction constrainer enablers. 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	clearRuledAuctionConstrainerIdTerms() Clears the auction constrainer Id query terms.
void	clearRuledAuctionConstrainerTerms() Clears the auction constrainer query terms.
AuctionConstrainerEnablerQueryRecord	getAuctionConstrainerEnablerQueryRecord(Type auctionConstrainerEnablerRecordType) Gets the auction constrainer enabler query record corresponding to the given AuctionConstrainerEnabler record Type.
AuctionHouseQuery	getAuctionHouseQuery() Gets the query for a auction house.
AuctionConstrainerQuery	getRuledAuctionConstrainerQuery() Gets the query for an auction constrainer.
void	matchAnyRuledAuctionConstrainer(boolean match) Matches enablers mapped to any auction constrainer.
void	matchAuctionHouseId(Id auctionHouseId, boolean match) Matches enablers mapped to the auction house.
void	matchRuledAuctionConstrainerId(Id auctionConstrainerId, boolean match) Matches enablers mapped to the auction constrainer.
boolean	supportsAuctionHouseQuery() Tests if a AuctionHouseQuery is available.
boolean	supportsRuledAuctionConstrainerQuery() Tests if an AuctionConstrainerQuery is available.

Methods inherited from interface org.osid.OsidEnablerQuery

clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery

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

Methods inherited from interface org.osid.OsidTemporalQuery

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

Method Detail

matchRuledAuctionConstrainerId

void matchRuledAuctionConstrainerId(Id auctionConstrainerId,
                                  boolean match)

Matches enablers mapped to the auction constrainer.

Parameters:

auctionConstrainerId - the auction constrainer Id

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

Throws:

NullArgumentException - auctionConstrainerId is null

Compliance:

mandatory - This method must be implemented.

clearRuledAuctionConstrainerIdTerms

void clearRuledAuctionConstrainerIdTerms()

Clears the auction constrainer Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledAuctionConstrainerQuery

boolean supportsRuledAuctionConstrainerQuery()

Tests if an AuctionConstrainerQuery is available.

Returns:

true if an auction constrainer query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledAuctionConstrainerQuery

AuctionConstrainerQuery getRuledAuctionConstrainerQuery()

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

Returns:

the auction constrainer query

Throws:

UnimplementedException - supportsRuledAuctionConstrainerQuery() is false

Compliance:

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

matchAnyRuledAuctionConstrainer

void matchAnyRuledAuctionConstrainer(boolean match)

Matches enablers mapped to any auction constrainer.

Parameters:

match - true for enablers mapped to any auction constrainer, false to match enablers mapped to no auction constrainers

Compliance:

mandatory - This method must be implemented.

clearRuledAuctionConstrainerTerms

void clearRuledAuctionConstrainerTerms()

Clears the auction constrainer query terms.

Compliance:

mandatory - This method must be implemented.

matchAuctionHouseId

void matchAuctionHouseId(Id auctionHouseId,
                       boolean match)

Matches enablers 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.

getAuctionConstrainerEnablerQueryRecord

AuctionConstrainerEnablerQueryRecord getAuctionConstrainerEnablerQueryRecord(Type auctionConstrainerEnablerRecordType)
                                                                             throws OperationFailedException

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

Parameters:

auctionConstrainerEnablerRecordType - an auction constrainer enabler record type

Returns:

the auction constrainer enabler query record

Throws:

NullArgumentException - auctionConstrainerEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionConstrainerEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.