OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.ProductQuery
Implementsosid.OsidObjectQuery
Description

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

MethodmatchCode
Description

Matches product codes.

Parametersstringcodea product code
osid.type.TypestringMatchTypea string match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT code not of stringMatchType
NULL_ARGUMENT code or stringMatchType is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyCode
Description

Matches products with any code.

Parametersbooleanmatch true to match products with any code, false to match products with no code
CompliancemandatoryThis method must be implemented.
MethodclearCodeTerms
Description

Clears the code.

CompliancemandatoryThis method must be implemented.
MethodmatchPriceScheduleId
Description

Sets the price schedule Id for this query.

Parametersosid.id.IdpriceScheduleIda price schedule Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT priceScheduleId is null
CompliancemandatoryThis method must be implemented.
MethodclearPriceScheduleIdTerms
Description

Clears the price schedule Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsPriceScheduleQuery
Description

Tests if a price schedule query is available.

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

Gets the query for a price schedule.

Returnosid.ordering.PriceScheduleQuerythe price schedule query
ErrorsUNIMPLEMENTED supportsPriceScheduleQuery() is false
ComplianceoptionalThis method must be implemented if supportsPriceScheduleQuery() is true.
MethodmatchAnyPriceSchedule
Description

Matches products with any price schedule.

Parametersbooleanmatch true to match products with any price schedule, false to match products with no price schedule
CompliancemandatoryThis method must be implemented.
MethodclearPriceScheduleTerms
Description

Clears the price schedule terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAvailability
Description

Matches product availability between the given range inclusive.

Parameterscardinallowa product code
cardinalhigha string match type
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
CompliancemandatoryThis method must be implemented.
MethodmatchAnyAvailability
Description

Matches products with any availability set.

Parametersbooleanmatch true to match products with anyavailability value, false to match products with no availability value
CompliancemandatoryThis method must be implemented.
MethodclearAvailabilityTerms
Description

Clears the availability terms.

CompliancemandatoryThis method must be implemented.
MethodmatchItemId
Description

Sets the item Id for this query.

Parametersosid.id.IditemIdan item Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT priceScheduleId is null
CompliancemandatoryThis method must be implemented.
MethodclearItemIdTerms
Description

Clears the item Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsItemQuery
Description

Tests if an item query is available.

Returnboolean true if an item query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetItemQuery
Description

Gets the query for an item.

Returnosid.ordering.ItemQuerythe item query
ErrorsUNIMPLEMENTED supportsItemQuery() is false
ComplianceoptionalThis method must be implemented if supportsItemQuery() is true.
MethodmatchAnyItem
Description

Matches prices used with any item.

Parametersbooleanmatch true to match prices with any order, false to match prices with no orders
CompliancemandatoryThis method must be implemented.
MethodclearItemTerms
Description

Clears the item terms.

CompliancemandatoryThis method must be implemented.
MethodmatchStoreId
Description

Sets the product 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.
MethodgetProductQueryRecord
Description

Gets the product query record corresponding to the given Product record Type. Multiple record retrievals produce a nested boolean OR term.

Parametersosid.type.TypeproductRecordTypean product record type
Returnosid.ordering.records.ProductQueryRecordthe product query record
ErrorsNULL_ARGUMENT productRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(productRecordType) is false
CompliancemandatoryThis method must be implemented.