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.
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. |
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 matchRuledAuctionConstrainerId(Id auctionConstrainerId, boolean match)
auctionConstrainerId
- the auction constrainer Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- auctionConstrainerId
is null
mandatory
- This method must be implemented. void clearRuledAuctionConstrainerIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledAuctionConstrainerQuery()
AuctionConstrainerQuery
is available. true
if an auction constrainer query is
available, false
otherwisemandatory
- This method must be implemented. AuctionConstrainerQuery getRuledAuctionConstrainerQuery()
OR
term.UnimplementedException
-
supportsRuledAuctionConstrainerQuery()
is false
optional
- This method must be implemented if
supportsRuledAuctionConstrainerQuery()
is
true.
void matchAnyRuledAuctionConstrainer(boolean match)
match
- true
for enablers mapped to any auction
constrainer, false
to match enablers mapped to
no auction constrainersmandatory
- This method must be implemented. void clearRuledAuctionConstrainerTerms()
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. AuctionConstrainerEnablerQueryRecord getAuctionConstrainerEnablerQueryRecord(Type auctionConstrainerEnablerRecordType) throws OperationFailedException
AuctionConstrainerEnabler
record Type.
Multiple record retrievals produce a nested OR
term.auctionConstrainerEnablerRecordType
- an auction constrainer
enabler record typeNullArgumentException
-
auctionConstrainerEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(auctionConstrainerEnablerRecordType)
is
false
mandatory
- This method must be implemented.