OSID Logo
OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.ModelQuery
Implementsosid.OsidObjectQuery
Description

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

MethodmatchManufacturerId
Description

Sets the inventory Id for this query to match models that have a related manufacturer.

Parametersosid.id.IdresourceIda resource Id
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearManufacturerIdTerms
Description

Clears the manufacturer terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsManufacturerQuery
Description

Tests if a ManufacturerQuery is available for the location.

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

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

Returnosid.resource.ResourceQuerythe manufacturer query
ErrorsUNIMPLEMENTED supportsManufacturerQuery() is false
ComplianceoptionalThis method must be implemented if supportsManufacturerQuery() is true.
MethodmatchAnyManufacturer
Description

Matches any manufacturer.

Parametersbooleanmatch true to match models with any inventory, false to match models with no inventories
CompliancemandatoryThis method must be implemented.
MethodclearManufacturerTerms
Description

Clears the manufacturer terms.

CompliancemandatoryThis method must be implemented.
MethodmatchArchetype
Description

Matches an archetype.

Parametersstringarchetypean archetype for the model
osid.type.TypestringMatchTypea string match type
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT archetype or stringMatchType is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodmatchAnyArchetype
Description

Matches items that have any archetype.

Parametersbooleanmatch true to match items with any archetype, false to match items with no archetype
CompliancemandatoryThis method must be implemented.
MethodclearArchetypeTerms
Description

Clears the archetype terms.

CompliancemandatoryThis method must be implemented.
MethodmatchNumber
Description

Matches a model number.

Parametersstringnumbera model number
osid.type.TypestringMatchTypea string match type
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT number or stringMatchType is null
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
CompliancemandatoryThis method must be implemented.
MethodmatchAnyNumber
Description

Matches items that have any model number.

Parametersbooleanmatch true to match items with any model number, false to match items with no model number
CompliancemandatoryThis method must be implemented.
MethodclearNumberTerms
Description

Clears the model number terms.

CompliancemandatoryThis method must be implemented.
MethodmatchWarehouseId
Description

Sets the warehouse Id for this query to match models 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 query 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.
MethodgetModelQueryRecord
Description

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

Parametersosid.type.TypemodelRecordTypea model record type
Returnosid.inventory.records.ModelQueryRecordthe model query record
ErrorsNULL_ARGUMENT modelRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(modelRecordType) is false
CompliancemandatoryThis method must be implemented.