public interface AuctionProcessorQuery extends OsidProcessorQuery
This is the query for searching auction processors. 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 |
clearRuledAuctionIdTerms()
Clears the auction
Id query terms. |
void |
clearRuledAuctionTerms()
Clears the auction query terms.
|
AuctionHouseQuery |
getAuctionHouseQuery()
Gets the query for a auction house.
|
AuctionProcessorQueryRecord |
getAuctionProcessorQueryRecord(Type auctionProcessorRecordType)
Gets the auction processor query record corresponding to the given
AuctionProcessor record Type. |
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. |
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
void matchRuledAuctionId(Id auctionId, boolean match)
auctionId
- the auction Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- auctionId
is
null
mandatory
- This method must be implemented. void clearRuledAuctionIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledAuctionQuery()
AuctionQuery
is available. true
if an auction query is available,
false
otherwisemandatory
- This method must be implemented. AuctionQuery getRuledAuctionQuery()
OR
term.UnimplementedException
-
supportsRuledAuctionQuery()
is false
optional
- This method must be implemented if
supportsRuledAuctionQuery()
is true.
void matchAnyRuledAuction(boolean match)
match
- true
for mapped to any auction,
false
to match mapped to no auctionmandatory
- This method must be implemented. void clearRuledAuctionTerms()
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. AuctionProcessorQueryRecord getAuctionProcessorQueryRecord(Type auctionProcessorRecordType) throws OperationFailedException
AuctionProcessor
record Type.
Multiple
record retrievals produce a nested OR
term.auctionProcessorRecordType
- an auction processor record typeNullArgumentException
-
auctionProcessorRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(auctionProcessorRecordType)
is
false
mandatory
- This method must be implemented.