OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.StoreQuery
Implementsosid.OsidCatalogQuery
Description

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

MethodmatchOrderId
Description

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

Parametersosid.id.IdorderIda order Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT orderId is null
CompliancemandatoryThis method must be implemented.
MethodclearOrderIdTerms
Description

Clears the order Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsOrderQuery
Description

Tests if a order query is available.

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

Gets the query for an order.

Returnosid.ordering.OrderQuerythe order query
ErrorsUNIMPLEMENTED supportsOrderQuery() is false
ComplianceoptionalThis method must be implemented if supportsOrderQuery() is true.
MethodmatchAnyOrder
Description

Matches stores with any order.

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

Clears the order 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 stores with any product.

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

Clears the product terms.

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.
MethodmatchAncestorStoreId
Description

Sets the store Id for this query to match stores that have the specified store as an ancestor.

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.
MethodclearAncestorStoreIdTerms
Description

Clears the ancestor store Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorStoreQuery
Description

Tests if a StoreQuery is available.

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

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

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

Matches stores with any ancestor.

Parametersbooleanmatch true to match stores with any ancestor, false to match root stores
CompliancemandatoryThis method must be implemented.
MethodclearAncestorStoreTerms
Description

Clears the ancestor store terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantStoreId
Description

Sets the store Id for this query to match stores that have the specified store as a descendant.

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.
MethodclearDescendantStoreIdTerms
Description

Clears the descendant store Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantStoreQuery
Description

Tests if a StoreQuery is available.

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

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

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

Matches stores with any descendant.

Parametersbooleanmatch true to match stores with any descendant, false to match leaf stores
CompliancemandatoryThis method must be implemented.
MethodclearDescendantStoreTerms
Description

Clears the descendant store terms.

CompliancemandatoryThis method must be implemented.
MethodgetStoreQueryRecord
Description

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

Parametersosid.type.TypestoreRecordTypea store record type
Returnosid.ordering.records.StoreQueryRecordthe store query record
ErrorsNULL_ARGUMENT storeRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(storeRecordType) is false
CompliancemandatoryThis method must be implemented.