Interface | osid.inventory.StockQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
osid.OsidFederateableQuery | |||
Description |
This is the query for searching stocks. Each method match
specifies an | ||
Method | matchSKU | ||
Description |
Matches a sku number. | ||
Parameters | string | sku | a sku |
osid.type.Type | stringMatchType | a string match type | |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | sku or stringMatchType is null | |
UNSUPPORTED | supportsStringMatchType(stringMatchType) is false
| ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnySKU | ||
Description |
Matches items that have any sku. | ||
Parameters | boolean | match | true to match items with any sku, false to
match items with no sku |
Compliance | mandatory | This method must be implemented. | |
Method | clearSKUTerms | ||
Description |
Clears the sku terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchModelId | ||
Description |
Sets the model | ||
Parameters | osid.id.Id | modelId | a model Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | modelId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearModelIdTerms | ||
Description |
Clears the model | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsModelQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a model query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getModelQuery | ||
Description |
Gets the query for an inventory. Multiple retrievals
produce a nested | ||
Return | osid.inventory.ModelQuery | the model query | |
Errors | UNIMPLEMENTED | supportsModelQuery() is false | |
Compliance | optional | This method must be implemented if supportsModelQuery() is
true. | |
Method | matchAnyModel | ||
Description |
Matches any related model. | ||
Parameters | boolean | match | true to match stocks with any model, false to
match stocks with no models |
Compliance | mandatory | This method must be implemented. | |
Method | clearModelTerms | ||
Description |
Clears the model terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchLocationDescription | ||
Description |
Matches a location description. | ||
Parameters | string | location | a location string |
osid.type.Type | stringMatchType | a string match type | |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | location or stringMatchType is null
| |
UNSUPPORTED | supportsStringMatchType(stringMatchType) is false
| ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyLocationDescription | ||
Description |
Matches items that have any location description. | ||
Parameters | boolean | match | true to match stocks with any location string, false
to match stocks with no location string |
Compliance | mandatory | This method must be implemented. | |
Method | clearLocationDescriptionTerms | ||
Description |
Clears the location description terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchLocationId | ||
Description |
Sets the location | ||
Parameters | osid.id.Id | locationId | the location Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | locationId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearLocationIdTerms | ||
Description |
Clears the location | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsLocationQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a location query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getLocationQuery | ||
Description |
Gets the query for a location. Multiple retrievals
produce a nested | ||
Return | osid.mapping.LocationQuery | the location query | |
Errors | UNIMPLEMENTED | supportsLocationQuery() is false | |
Compliance | optional | This method must be implemented if supportsLocationQuery()
is true. | |
Method | matchAnyLocation | ||
Description |
Matches items that have any location. | ||
Parameters | boolean | match | true to match stocks with any location, false
to match stocks with no location |
Compliance | mandatory | This method must be implemented. | |
Method | clearLocationTerms | ||
Description |
Clears the location terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAncestorStockId | ||
Description |
Sets the stock | ||
Parameters | osid.id.Id | stockId | a stock Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | stockId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAncestorStockIdTerms | ||
Description |
Clears the ancestor stock | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAncestorStockQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a stock query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAncestorStockQuery | ||
Description |
Gets the query for a stock. Multiple retrievals produce
a nested | ||
Return | osid.inventory.StockQuery | the stock query | |
Errors | UNIMPLEMENTED | supportsAncestorStockQuery() is false | |
Compliance | optional | This method must be implemented if supportsAncestorStockQuery()
is true. | |
Method | matchAnyAncestorStock | ||
Description |
Matches stocks with any stock ancestor. | ||
Parameters | boolean | match | true to match stocks with any ancestor, false
to match root stocks |
Compliance | mandatory | This method must be implemented. | |
Method | clearAncestorStockTerms | ||
Description |
Clears the ancestor stock query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDescendantStockId | ||
Description |
Sets the stock | ||
Parameters | osid.id.Id | stockId | a stock Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | stockId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearDescendantStockIdTerms | ||
Description |
Clears the descendant stock | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDescendantStockQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a stock query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescendantStockQuery | ||
Description |
Gets the query for a stock. Multiple retrievals produce
a nested | ||
Return | osid.inventory.StockQuery | the stock query | |
Errors | UNIMPLEMENTED | supportsDescendantStockQuery() is false | |
Compliance | optional | This method must be implemented if supportsDescendantStockQuery()
is true. | |
Method | matchAnyDescendantStock | ||
Description |
Matches stocks with any descendant stock. | ||
Parameters | boolean | match | true to match stocks with any descendant, false
to match leaf stocks |
Compliance | mandatory | This method must be implemented. | |
Method | clearDescendantStockTerms | ||
Description |
Clears the descendant stock query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchWarehouseId | ||
Description |
Sets the warehouse | ||
Parameters | osid.id.Id | warehouseId | the warehouse Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | warehouseId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearWarehouseIdTerms | ||
Description |
Clears the warehouse | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsWarehouseQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a warehouse query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getWarehouseQuery | ||
Description |
Gets the query for a warehouse. Multiple retrievals
produce a nested | ||
Return | osid.inventory.WarehouseQuery | the warehouse query | |
Errors | UNIMPLEMENTED | supportsWarehouseQuery() is false | |
Compliance | optional | This method must be implemented if supportsWarehouseQuery()
is true. | |
Method | clearWarehouseTerms | ||
Description |
Clears the warehouse terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStockQueryRecord | ||
Description |
Gets the stock query record corresponding to the given
| ||
Parameters | osid.type.Type | stockRecordType | a stock record type |
Return | osid.inventory.records.StockQueryRecord | the stock query record | |
Errors | NULL_ARGUMENT | stockRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(stockRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |