Interface | osid.inventory.shipment.EntryQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
osid.OsidSubjugateableQuery | |||
Description |
This is the query for searching entries. Each method match
specifies an | ||
Method | matchStockId | ||
Description |
Sets the stock | ||
Parameters | osid.id.Id | stockId | a stock Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | stockId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearStockIdTerms | ||
Description |
Clears the stock | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsStockQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a stock query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getStockQuery | ||
Description |
Gets the query for a stock. Multiple retrievals produce
a nested | ||
Return | osid.inventory.StockQuery | the stock query | |
Errors | UNIMPLEMENTED | supportsStockQuery() is false | |
Compliance | optional | This method must be implemented if supportsStockQuery() is
true. | |
Method | clearStockTerms | ||
Description |
Clears the stock 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 a model. 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 entries that have any model set. | ||
Parameters | boolean | match | true to match entries with any model, false
to match entries with no model |
Compliance | mandatory | This method must be implemented. | |
Method | clearModelTerms | ||
Description |
Clears the model terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchItemId | ||
Description |
Sets the item | ||
Parameters | osid.id.Id | itemId | an item Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | itemId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearItemIdTerms | ||
Description |
Clears the item | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsItemQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an item query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getItemQuery | ||
Description |
Gets the query for an item. Multiple retrievals produce
a nested | ||
Return | osid.inventory.ItemQuery | the item query | |
Errors | UNIMPLEMENTED | supportsItemQuery() is false | |
Compliance | optional | This method must be implemented if supportsItemQuery() is
true. | |
Method | matchAnyItem | ||
Description |
Matches entries that have any item set. | ||
Parameters | boolean | match | true to match entries with any item, false to
match entries with no item |
Compliance | mandatory | This method must be implemented. | |
Method | clearItemTerms | ||
Description |
Clears the item terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchQuantity | ||
Description |
Matches entries with a quantity between the given range inclusive. | ||
Parameters | decimal | low | start of range |
decimal | high | end of range | |
boolean | match | true if a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | low is greater than high | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyQuantity | ||
Description |
Matches entries that have any quantity set. | ||
Parameters | boolean | match | true to match entries with any quantity, false
to match entries with no quantity |
Compliance | mandatory | This method must be implemented. | |
Method | clearQuantityTerms | ||
Description |
Clears the quantity terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchUnitType | ||
Description |
Matches the a unit type. | ||
Parameters | osid.type.Type | type | a unit tytpe |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | type is null | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyUnitType | ||
Description |
Matches entries that have any unit type set. | ||
Parameters | boolean | match | true to match entries with any unit type, false
to match entries with no unit type |
Compliance | mandatory | This method must be implemented. | |
Method | clearUnitTypeTerms | ||
Description |
Clears the unit type 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 | getEntryQueryRecord | ||
Description |
Gets the entry query record corresponding to the given
| ||
Parameters | osid.type.Type | entryRecordType | an entry record type |
Return | osid.inventory.shipment.records.EntryQueryRecord | the entry query record | |
Errors | NULL_ARGUMENT | entryRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(entryRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |