Interface | osid.ordering.StoreQuery | ||
---|---|---|---|
Implements | osid.OsidCatalogQuery | ||
Description |
This is the query for searching for stores. Each method
specifies an | ||
Method | matchOrderId | ||
Description |
Sets the order | ||
Parameters | osid.id.Id | orderId | a order Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | orderId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearOrderIdTerms | ||
Description |
Clears the order | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsOrderQuery | ||
Description |
Tests if a order query is available. | ||
Return | boolean | true if a order query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getOrderQuery | ||
Description |
Gets the query for an order. | ||
Return | osid.ordering.OrderQuery | the order query | |
Errors | UNIMPLEMENTED | supportsOrderQuery() is false | |
Compliance | optional | This method must be implemented if supportsOrderQuery() is
true. | |
Method | matchAnyOrder | ||
Description |
Matches stores with any order. | ||
Parameters | boolean | match | true to match stores with any order, false to
match stores with no orders |
Compliance | mandatory | This method must be implemented. | |
Method | clearOrderTerms | ||
Description |
Clears the order terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchProductId | ||
Description |
Sets the product | ||
Parameters | osid.id.Id | productId | a product Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | productId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearProductIdTerms | ||
Description |
Clears the product | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsProductQuery | ||
Description |
Tests if a product query is available. | ||
Return | boolean | true if a product query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getProductQuery | ||
Description |
Gets the query for a product. | ||
Return | osid.ordering.ProductQuery | the product query | |
Errors | UNIMPLEMENTED | supportsProductQuery() is false | |
Compliance | optional | This method must be implemented if supportsProductQuery() is
true. | |
Method | matchAnyProduct | ||
Description |
Matches stores with any product. | ||
Parameters | boolean | match | true to match stores with any product, false
to match stores with no products |
Compliance | mandatory | This method must be implemented. | |
Method | clearProductTerms | ||
Description |
Clears the product terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchPriceScheduleId | ||
Description |
Sets the price schedule | ||
Parameters | osid.id.Id | priceScheduleId | a price schedule Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | priceScheduleId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearPriceScheduleIdTerms | ||
Description |
Clears the price schedule | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsPriceScheduleQuery | ||
Description |
Tests if a price schedule query is available. | ||
Return | boolean | true if a price schedule query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getPriceScheduleQuery | ||
Description |
Gets the query for a price schedule. | ||
Return | osid.ordering.PriceScheduleQuery | the price schedule query | |
Errors | UNIMPLEMENTED | supportsPriceScheduleQuery() is false | |
Compliance | optional | This method must be implemented if supportsPriceScheduleQuery()
is true. | |
Method | matchAnyPriceSchedule | ||
Description |
Matches products with any price schedule. | ||
Parameters | boolean | match | true to match products with any price schedule, false
to match products with no price schedule |
Compliance | mandatory | This method must be implemented. | |
Method | clearPriceScheduleTerms | ||
Description |
Clears the price schedule terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAncestorStoreId | ||
Description |
Sets the store | ||
Parameters | osid.id.Id | storeId | a store Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | storeId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAncestorStoreIdTerms | ||
Description |
Clears the ancestor store | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAncestorStoreQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a store query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAncestorStoreQuery | ||
Description |
Gets the query for a store. Multiple retrievals produce
a nested | ||
Return | osid.ordering.StoreQuery | the store query | |
Errors | UNIMPLEMENTED | supportsAncestorStoreQuery() is false | |
Compliance | optional | This method must be implemented if supportsAncestorStoreQuery()
is true. | |
Method | matchAnyAncestorStore | ||
Description |
Matches stores with any ancestor. | ||
Parameters | boolean | match | true to match stores with any ancestor, false
to match root stores |
Compliance | mandatory | This method must be implemented. | |
Method | clearAncestorStoreTerms | ||
Description |
Clears the ancestor store terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDescendantStoreId | ||
Description |
Sets the store | ||
Parameters | osid.id.Id | storeId | a store Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | storeId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearDescendantStoreIdTerms | ||
Description |
Clears the descendant store | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDescendantStoreQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a store query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescendantStoreQuery | ||
Description |
Gets the query for a store. Multiple retrievals produce
a nested | ||
Return | osid.ordering.StoreQuery | the store query | |
Errors | UNIMPLEMENTED | supportsDescendantStoreQuery() is false | |
Compliance | optional | This method must be implemented if supportsDescendantStoreQuery()
is true. | |
Method | matchAnyDescendantStore | ||
Description |
Matches stores with any descendant. | ||
Parameters | boolean | match | true to match stores with any descendant, false
to match leaf stores |
Compliance | mandatory | This method must be implemented. | |
Method | clearDescendantStoreTerms | ||
Description |
Clears the descendant store terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStoreQueryRecord | ||
Description |
Gets the store query record corresponding to the given
| ||
Parameters | osid.type.Type | storeRecordType | a store record type |
Return | osid.ordering.records.StoreQueryRecord | the store query record | |
Errors | NULL_ARGUMENT | storeRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(storeRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |