Interface | osid.inventory.ModelQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
Description |
This is the query for searching models. Each method match
specifies an | ||
Method | matchManufacturerId | ||
Description |
Sets the inventory | ||
Parameters | osid.id.Id | resourceId | a resource Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearManufacturerIdTerms | ||
Description |
Clears the manufacturer terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsManufacturerQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a manufacturer query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getManufacturerQuery | ||
Description |
Gets the query for a manufacturer. Multiple retrievals
produce a nested | ||
Return | osid.resource.ResourceQuery | the manufacturer query | |
Errors | UNIMPLEMENTED | supportsManufacturerQuery() is false | |
Compliance | optional | This method must be implemented if supportsManufacturerQuery()
is true. | |
Method | matchAnyManufacturer | ||
Description |
Matches any manufacturer. | ||
Parameters | boolean | match | true to match models with any inventory, false
to match models with no inventories |
Compliance | mandatory | This method must be implemented. | |
Method | clearManufacturerTerms | ||
Description |
Clears the manufacturer terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchArchetype | ||
Description |
Matches an archetype. | ||
Parameters | string | archetype | an archetype for the model |
osid.type.Type | stringMatchType | a string match type | |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | archetype or stringMatchType is null
| |
UNSUPPORTED | supportsStringMatchType(stringMatchType) is false
| ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyArchetype | ||
Description |
Matches items that have any archetype. | ||
Parameters | boolean | match | true to match items with any archetype, false
to match items with no archetype |
Compliance | mandatory | This method must be implemented. | |
Method | clearArchetypeTerms | ||
Description |
Clears the archetype terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchNumber | ||
Description |
Matches a model number. | ||
Parameters | string | number | a model number |
osid.type.Type | stringMatchType | a string match type | |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | number or stringMatchType is null
| |
UNSUPPORTED | supportsStringMatchType(stringMatchType) is false
| ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyNumber | ||
Description |
Matches items that have any model number. | ||
Parameters | boolean | match | true to match items with any model number, false
to match items with no model number |
Compliance | mandatory | This method must be implemented. | |
Method | clearNumberTerms | ||
Description |
Clears the model number 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 | getModelQueryRecord | ||
Description |
Gets the model query record corresponding to the given
| ||
Parameters | osid.type.Type | modelRecordType | a model record type |
Return | osid.inventory.records.ModelQueryRecord | the model query record | |
Errors | NULL_ARGUMENT | modelRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(modelRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |