OSID Logo
OSID Specifications
ordering rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.rules.PriceEnablerQuery
Implementsosid.OsidEnablerQuery
Description

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.

MethodmatchRuledPriceId
Description

Matches enablers mapped to the price.

Parametersosid.id.IdpriceIdthe price Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT priceId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledPriceIdTerms
Description

Clears the price Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledPriceQuery
Description

Tests if a PriceQuery is available.

Returnboolean true if a price query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRuledPriceQuery
Description

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

Returnosid.ordering.PriceQuerythe price query
ErrorsUNIMPLEMENTED supportsRuledPriceQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledPriceQuery() is true.
MethodmatchAnyRuledPrice
Description

Matches enablers mapped to any price.

Parametersbooleanmatch true for enablers mapped to any price, false to match enablers mapped to no price
CompliancemandatoryThis method must be implemented.
MethodclearRuledPriceTerms
Description

Clears the price query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchStoreId
Description

Matches enablers mapped to the store.

Parametersosid.id.IdstoreIdthe store Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT storeId is null
CompliancemandatoryThis method must be implemented.
MethodclearStoreIdTerms
Description

Clears the store Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsStoreQuery
Description

Tests if a StoreQuery is available.

Returnboolean true if a store query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetStoreQuery
Description

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

Returnosid.ordering.StoreQuerythe store query
ErrorsUNIMPLEMENTED supportsStoreQuery() is false
ComplianceoptionalThis method must be implemented if supportsStoreQuery() is true.
MethodclearStoreTerms
Description

Clears the store query terms.

CompliancemandatoryThis method must be implemented.
MethodgetPriceEnablerQueryRecord
Description

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

Parametersosid.type.TypepriceEnablerRecordTypea price enabler record type
Returnosid.ordering.rules.records.PriceEnablerQueryRecordthe price enabler query record
ErrorsNULL_ARGUMENT priceEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(priceEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.