OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.ItemQuery
Implementsosid.OsidRelationshipQuery
Description

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

MethodmatchOrderId
Description

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

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 item.

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

Clears the order terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDerived
Description

Matches items that are derived.

Parametersbooleanmatch true to match derived items, false to match selected items
CompliancemandatoryThis method must be implemented.
MethodclearDerivedTerms
Description

Clears the derived 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.
MethodclearProductTerms
Description

Clears the product terms.

CompliancemandatoryThis method must be implemented.
MethodmatchQuantity
Description

Matches quantities between the given range inclusive.

Parameterscardinallowlow range
cardinalhighhigh range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
CompliancemandatoryThis method must be implemented.
MethodclearQuantityTerms
Description

Clears the quantity terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCost
Description

Matches costs between the given range inclusive.

Parametersosid.financials.Currencylowlow range
osid.financials.Currencyhighhigh range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
NULL_ARGUMENT low or high is null
CompliancemandatoryThis method must be implemented.
MethodclearCostTerms
Description

Clears the cost terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMinimumCost
Description

Matches minimum costs between the given range inclusive.

Parametersosid.financials.Currencycostcost
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT cost is null
CompliancemandatoryThis method must be implemented.
MethodclearMinimumCostTerms
Description

Clears the minimum cost terms.

CompliancemandatoryThis method must be implemented.
MethodmatchStoreId
Description

Sets the item 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.
MethodgetItemQueryRecord
Description

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

Parametersosid.type.TypeitemRecordTypean item record type
Returnosid.ordering.records.ItemQueryRecordthe item query record
ErrorsNULL_ARGUMENT itemRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(itemRecordType) is false
CompliancemandatoryThis method must be implemented.