org.osid.bidding.rules

Interface AuctionProcessorEnablerQuery

All Superinterfaces:

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

public interface AuctionProcessorEnablerQuery
extends OsidEnablerQuery

This is the query for searching auction processor 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	clearRuledAuctionProcessorIdTerms() Clears the auction processor Id query terms.
void	clearRuledAuctionProcessorTerms() Clears the auction processor query terms.
AuctionHouseQuery	getAuctionHouseQuery() Gets the query for a auction house.
AuctionProcessorEnablerQueryRecord	getAuctionProcessorEnablerQueryRecord(Type auctionProcessorEnablerRecordType) Gets the auction processor enabler query record corresponding to the given AuctionProcessorEnabler record Type.
AuctionProcessorQuery	getRuledAuctionProcessorQuery() Gets the query for an auction processor.
void	matchAnyRuledAuctionProcessor(boolean match) Matches enablers mapped to any auction processor.
void	matchAuctionHouseId(Id auctionHouseId, boolean match) Matches enablers mapped to the auction house.
void	matchRuledAuctionProcessorId(Id auctionProcessorId, boolean match) Matches enablers mapped to the auction processor.
boolean	supportsAuctionHouseQuery() Tests if a AuctionHouseQuery is available.
boolean	supportsRuledAuctionProcessorQuery() Tests if an AuctionProcessorQuery 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

matchRuledAuctionProcessorId

void matchRuledAuctionProcessorId(Id auctionProcessorId,
                                boolean match)

Matches enablers mapped to the auction processor.

Parameters:

auctionProcessorId - the auction Id

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

Throws:

NullArgumentException - auctionProcessorId is null

Compliance:

mandatory - This method must be implemented.

clearRuledAuctionProcessorIdTerms

void clearRuledAuctionProcessorIdTerms()

Clears the auction processor Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledAuctionProcessorQuery

boolean supportsRuledAuctionProcessorQuery()

Tests if an AuctionProcessorQuery is available.

Returns:

true if an auction processor query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledAuctionProcessorQuery

AuctionProcessorQuery getRuledAuctionProcessorQuery()

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

Returns:

the auction processor query

Throws:

UnimplementedException - supportsRuledAuctionProcessorQuery() is false

Compliance:

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

matchAnyRuledAuctionProcessor

void matchAnyRuledAuctionProcessor(boolean match)

Matches enablers mapped to any auction processor.

Parameters:

match - true for enablers mapped to any auction processor, false to match enablers mapped to no auction processors

Compliance:

mandatory - This method must be implemented.

clearRuledAuctionProcessorTerms

void clearRuledAuctionProcessorTerms()

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

getAuctionProcessorEnablerQueryRecord

AuctionProcessorEnablerQueryRecord getAuctionProcessorEnablerQueryRecord(Type auctionProcessorEnablerRecordType)
                                                                         throws OperationFailedException

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

Parameters:

auctionProcessorEnablerRecordType - an auction processor enabler record type

Returns:

the auction processor enabler query record

Throws:

NullArgumentException - auctionProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auctionProcessorEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.