public interface PriceEnablerQuery extends OsidEnablerQuery
This is the query for searching price 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 |
clearRuledPriceIdTerms()
Clears the price
Id query terms. |
void |
clearRuledPriceTerms()
Clears the price query terms.
|
void |
clearStoreIdTerms()
Clears the store
Id query terms. |
void |
clearStoreTerms()
Clears the store query terms.
|
PriceEnablerQueryRecord |
getPriceEnablerQueryRecord(Type priceEnablerRecordType)
Gets the price enabler query record corresponding to the given
PriceEnabler record Type. |
PriceQuery |
getRuledPriceQuery()
Gets the query for a price.
|
StoreQuery |
getStoreQuery()
Gets the query for a store.
|
void |
matchAnyRuledPrice(boolean match)
Matches enablers mapped to any price.
|
void |
matchRuledPriceId(Id priceId,
boolean match)
Matches enablers mapped to the price.
|
void |
matchStoreId(Id storeId,
boolean match)
Matches enablers mapped to the store.
|
boolean |
supportsRuledPriceQuery()
Tests if a
PriceQuery is available. |
boolean |
supportsStoreQuery()
Tests if a
StoreQuery 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 matchRuledPriceId(Id priceId, boolean match)
priceId
- the price Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- priceId
is
null
mandatory
- This method must be implemented. void clearRuledPriceIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledPriceQuery()
PriceQuery
is available. true
if a price query is available,
false
otherwisemandatory
- This method must be implemented. PriceQuery getRuledPriceQuery()
OR
term.UnimplementedException
-
supportsRuledPriceQuery()
is false
optional
- This method must be implemented if
supportsRuledPriceQuery()
is true.
void matchAnyRuledPrice(boolean match)
match
- true
for enablers mapped to any price,
false
to match enablers mapped to no pricemandatory
- This method must be implemented. void clearRuledPriceTerms()
mandatory
- This method must be implemented. void matchStoreId(Id storeId, boolean match)
storeId
- the store Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- storeId
is
null
mandatory
- This method must be implemented. void clearStoreIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsStoreQuery()
StoreQuery
is available. true
if a store query is available,
false
otherwisemandatory
- This method must be implemented. StoreQuery getStoreQuery()
OR
term.UnimplementedException
- supportsStoreQuery()
is false
optional
- This method must be implemented if
supportsStoreQuery()
is true.
void clearStoreTerms()
mandatory
- This method must be implemented. PriceEnablerQueryRecord getPriceEnablerQueryRecord(Type priceEnablerRecordType) throws OperationFailedException
PriceEnabler
record Type.
Multiple record
retrievals produce a nested OR
term.priceEnablerRecordType
- a price enabler record typeNullArgumentException
- priceEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(priceEnablerRecordType)
is false
mandatory
- This method must be implemented.