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.
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. |
clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery
clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchRuledAuctionProcessorId(Id auctionProcessorId, boolean match)
auctionProcessorId
- the auction Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- auctionProcessorId
is null
mandatory
- This method must be implemented. void clearRuledAuctionProcessorIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledAuctionProcessorQuery()
AuctionProcessorQuery
is available. true
if an auction processor query is
available, false
otherwisemandatory
- This method must be implemented. AuctionProcessorQuery getRuledAuctionProcessorQuery()
OR
term.UnimplementedException
-
supportsRuledAuctionProcessorQuery()
is false
optional
- This method must be implemented if
supportsRuledAuctionProcessorQuery()
is
true.
void matchAnyRuledAuctionProcessor(boolean match)
match
- true
for enablers mapped to any auction
processor, false
to match enablers mapped to no
auction processorsmandatory
- This method must be implemented. void clearRuledAuctionProcessorTerms()
mandatory
- This method must be implemented. void matchAuctionHouseId(Id auctionHouseId, boolean match)
auctionHouseId
- the auction house Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- auctionHouseId
is null
mandatory
- This method must be implemented. void clearAuctionHouseIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAuctionHouseQuery()
AuctionHouseQuery
is available. true
if a auction house query is available,
false
otherwisemandatory
- This method must be implemented. AuctionHouseQuery getAuctionHouseQuery()
OR
term.UnimplementedException
-
supportsAuctionHouseQuery()
is false
optional
- This method must be implemented if
supportsAuctionHouseQuery()
is true.
void clearAuctionHouseTerms()
mandatory
- This method must be implemented. AuctionProcessorEnablerQueryRecord getAuctionProcessorEnablerQueryRecord(Type auctionProcessorEnablerRecordType) throws OperationFailedException
AuctionProcessorEnabler
record Type.
Multiple record retrievals produce a nested OR
term.auctionProcessorEnablerRecordType
- an auction processor enabler
record typeNullArgumentException
-
auctionProcessorEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(auctionProcessorEnablerRecordType)
is
false
mandatory
- This method must be implemented.