OSID Logo
OSID Specifications
inventory shipment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.shipment.EntryQuery
Implementsosid.OsidObjectQuery
osid.OsidSubjugateableQuery
Description

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

MethodmatchStockId
Description

Sets the stock Id for this query.

Parametersosid.id.IdstockIda stock Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT stockId is null
CompliancemandatoryThis method must be implemented.
MethodclearStockIdTerms
Description

Clears the stock Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsStockQuery
Description

Tests if a StockQuery is available.

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

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

Returnosid.inventory.StockQuerythe stock query
ErrorsUNIMPLEMENTED supportsStockQuery() is false
ComplianceoptionalThis method must be implemented if supportsStockQuery() is true.
MethodclearStockTerms
Description

Clears the stock terms.

CompliancemandatoryThis method must be implemented.
MethodmatchModelId
Description

Sets the model Id for this query.

Parametersosid.id.IdmodelIda model Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT modelId is null
CompliancemandatoryThis method must be implemented.
MethodclearModelIdTerms
Description

Clears the model Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsModelQuery
Description

Tests if a ModelQuery is available.

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

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

Returnosid.inventory.ModelQuerythe model query
ErrorsUNIMPLEMENTED supportsModelQuery() is false
ComplianceoptionalThis method must be implemented if supportsModelQuery() is true.
MethodmatchAnyModel
Description

Matches entries that have any model set.

Parametersbooleanmatch true to match entries with any model, false to match entries with no model
CompliancemandatoryThis method must be implemented.
MethodclearModelTerms
Description

Clears the model terms.

CompliancemandatoryThis method must be implemented.
MethodmatchItemId
Description

Sets the item Id for this query.

Parametersosid.id.IditemIdan item Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT itemId is null
CompliancemandatoryThis method must be implemented.
MethodclearItemIdTerms
Description

Clears the item Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsItemQuery
Description

Tests if an ItemQuery is available.

Returnboolean true if an item query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetItemQuery
Description

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

Returnosid.inventory.ItemQuerythe item query
ErrorsUNIMPLEMENTED supportsItemQuery() is false
ComplianceoptionalThis method must be implemented if supportsItemQuery() is true.
MethodmatchAnyItem
Description

Matches entries that have any item set.

Parametersbooleanmatch true to match entries with any item, false to match entries with no item
CompliancemandatoryThis method must be implemented.
MethodclearItemTerms
Description

Clears the item terms.

CompliancemandatoryThis method must be implemented.
MethodmatchQuantity
Description

Matches entries with a quantity between the given range inclusive.

Parametersdecimallowstart of range
decimalhighend of range
booleanmatch true if a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
CompliancemandatoryThis method must be implemented.
MethodmatchAnyQuantity
Description

Matches entries that have any quantity set.

Parametersbooleanmatch true to match entries with any quantity, false to match entries with no quantity
CompliancemandatoryThis method must be implemented.
MethodclearQuantityTerms
Description

Clears the quantity terms.

CompliancemandatoryThis method must be implemented.
MethodmatchUnitType
Description

Matches the a unit type.

Parametersosid.type.Typetypea unit tytpe
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT type is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyUnitType
Description

Matches entries that have any unit type set.

Parametersbooleanmatch true to match entries with any unit type, false to match entries with no unit type
CompliancemandatoryThis method must be implemented.
MethodclearUnitTypeTerms
Description

Clears the unit type terms.

CompliancemandatoryThis method must be implemented.
MethodmatchWarehouseId
Description

Sets the warehouse Id for this query to match entries assigned to warehouses.

Parametersosid.id.IdwarehouseIdthe warehouse Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT warehouseId is null
CompliancemandatoryThis method must be implemented.
MethodclearWarehouseIdTerms
Description

Clears the warehouse Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsWarehouseQuery
Description

Tests if a WarehouseQuery is available.

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

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

Returnosid.inventory.WarehouseQuerythe warehouse query
ErrorsUNIMPLEMENTED supportsWarehouseQuery() is false
ComplianceoptionalThis method must be implemented if supportsWarehouseQuery() is true.
MethodclearWarehouseTerms
Description

Clears the warehouse terms.

CompliancemandatoryThis method must be implemented.
MethodgetEntryQueryRecord
Description

Gets the entry query record corresponding to the given Entry record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypeentryRecordTypean entry record type
Returnosid.inventory.shipment.records.EntryQueryRecordthe entry query record
ErrorsNULL_ARGUMENT entryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(entryRecordType) is false
CompliancemandatoryThis method must be implemented.