OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.PriceScheduleQuery
Implementsosid.OsidObjectQuery
osid.OsidAggregateableQuery
Description

This is the query for searching for price schedules. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchPriceId
Description

Sets the price Id for this query.

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

Clears the price Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsPriceQuery
Description

Tests if a price query is available.

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

Gets the query for a price.

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

Matches price schedules with any price.

Parametersbooleanmatch true to match price sschedules with any price, false to match price schedules with no prices
CompliancemandatoryThis method must be implemented.
MethodclearPriceTerms
Description

Clears the price terms.

CompliancemandatoryThis method must be implemented.
MethodmatchProductId
Description

Sets the product Id for this query.

Parametersosid.id.IdproductIda product Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT productId is null
CompliancemandatoryThis method must be implemented.
MethodclearProductIdTerms
Description

Clears the product Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsProductQuery
Description

Tests if a product query is available.

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

Gets the query for a product.

Returnosid.ordering.ProductQuerythe product query
ErrorsUNIMPLEMENTED supportsProductQuery() is false
ComplianceoptionalThis method must be implemented if supportsProductQuery() is true.
MethodmatchAnyProduct
Description

Matches price schedules used with any product.

Parametersbooleanmatch true to match price schedules with any product, false to match price schedules with no products
CompliancemandatoryThis method must be implemented.
MethodclearProductTerms
Description

Clears the product terms.

CompliancemandatoryThis method must be implemented.
MethodmatchStoreId
Description

Sets the price Id for this query to match orders assigned to stores.

Parametersosid.id.IdstoreIda 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 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 query. 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 terms.

CompliancemandatoryThis method must be implemented.
MethodgetPriceScheduleQueryRecord
Description

Gets the price schedule query record corresponding to the given PriceSchedule record Type. Multiple record retrievals produce a nested boolean OR term.

Parametersosid.type.TypepriceScheduleRecordTypea price schedule record type
Returnosid.ordering.records.PriceScheduleQueryRecordthe price schedule query record
ErrorsNULL_ARGUMENT priceScheduleRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(priceScheduleRecordType) is false
CompliancemandatoryThis method must be implemented.