org.osid.ordering.rules

Interface PriceEnablerQuery

All Superinterfaces:

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

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.

Method Summary

Methods

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.

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

matchRuledPriceId

void matchRuledPriceId(Id priceId,
                     boolean match)

Matches enablers mapped to the price.

Parameters:

priceId - the price Id

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

Throws:

NullArgumentException - priceId is null

Compliance:

mandatory - This method must be implemented.

clearRuledPriceIdTerms

void clearRuledPriceIdTerms()

Clears the price Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledPriceQuery

boolean supportsRuledPriceQuery()

Tests if a PriceQuery is available.

Returns:

true if a price query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledPriceQuery

PriceQuery getRuledPriceQuery()

Gets the query for a price. Multiple retrievals produce a nested OR term.

Returns:

the price query

Throws:

UnimplementedException - supportsRuledPriceQuery() is false

Compliance:

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

matchAnyRuledPrice

void matchAnyRuledPrice(boolean match)

Matches enablers mapped to any price.

Parameters:

match - true for enablers mapped to any price, false to match enablers mapped to no price

Compliance:

mandatory - This method must be implemented.

clearRuledPriceTerms

void clearRuledPriceTerms()

Clears the price query terms.

Compliance:

mandatory - This method must be implemented.

matchStoreId

void matchStoreId(Id storeId,
                boolean match)

Matches enablers mapped to the store.

Parameters:

storeId - the store Id

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

Throws:

NullArgumentException - storeId is null

Compliance:

mandatory - This method must be implemented.

clearStoreIdTerms

void clearStoreIdTerms()

Clears the store Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsStoreQuery

boolean supportsStoreQuery()

Tests if a StoreQuery is available.

Returns:

true if a store query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStoreQuery

StoreQuery getStoreQuery()

Gets the query for a store. Multiple retrievals produce a nested OR term.

Returns:

the store query

Throws:

UnimplementedException - supportsStoreQuery() is false

Compliance:

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

clearStoreTerms

void clearStoreTerms()

Clears the store query terms.

Compliance:

mandatory - This method must be implemented.

getPriceEnablerQueryRecord

PriceEnablerQueryRecord getPriceEnablerQueryRecord(Type priceEnablerRecordType)
                                                   throws OperationFailedException

Gets the price enabler query record corresponding to the given PriceEnabler record Type. Multiple record retrievals produce a nested OR term.

Parameters:

priceEnablerRecordType - a price enabler record type

Returns:

the price enabler query record

Throws:

NullArgumentException - priceEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(priceEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.