org.osid.ordering.rules

Interface PriceEnablerQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidEnablerQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidRuleQueryInspector, OsidTemporalQueryInspector

public interface PriceEnablerQueryInspector
extends OsidEnablerQueryInspector

This is the query inspector for examining price enabler queries.

Method Summary

Methods

Modifier and Type	Method and Description
PriceEnablerQueryInspectorRecord	getPriceEnablerQueryInspectorRecord(Type priceEnablerRecordType) Gets the price enabler query inspector record corresponding to the given PriceEnabler record Type.
IdTerm[]	getRuledPriceIdTerms() Gets the price Id query terms.
StoreQueryInspector[]	getRuledPriceTerms() Gets the price query terms.
IdTerm[]	getStoreIdTerms() Gets the store Id query terms.
StoreQueryInspector[]	getStoreTerms() Gets the store query terms.

Methods inherited from interface org.osid.OsidEnablerQueryInspector

getCyclicEventIdTerms, getCyclicEventTerms, getDemographicIdTerms, getDemographicTerms, getEventIdTerms, getEventTerms, getScheduleIdTerms, getScheduleTerms

Methods inherited from interface org.osid.OsidRuleQueryInspector

getRuleIdTerms, getRuleTerms

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getRuledPriceIdTerms

IdTerm[] getRuledPriceIdTerms()

Gets the price Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledPriceTerms

StoreQueryInspector[] getRuledPriceTerms()

Gets the price query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getStoreIdTerms

IdTerm[] getStoreIdTerms()

Gets the store Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getStoreTerms

StoreQueryInspector[] getStoreTerms()

Gets the store query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getPriceEnablerQueryInspectorRecord

PriceEnablerQueryInspectorRecord getPriceEnablerQueryInspectorRecord(Type priceEnablerRecordType)
                                                                     throws OperationFailedException

Gets the price enabler query inspector record corresponding to the given PriceEnabler record Type.

Parameters:

priceEnablerRecordType - a price enabler record type

Returns:

the price enabler query inspector record

Throws:

NullArgumentException - priceEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(priceEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.