OSID Logo
OSID Specifications
inventory package
Version 3.1.0
Interfaceosid.inventory.ModelSearchOrder
Implementsosid.OsidObjectSearchOrder
Used Byosid.control.ControllerSearchOrder
osid.inventory.ModelSearchSession
osid.inventory.ModelSmartWarehouseSession
osid.inventory.shipment.EntrySearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByManufacturer
Description

Specifies a preference for ordering the result set by the manufacturer.

Parametersosid.SearchOrderStylestyle a search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodsupportsManufacturerSearchOrder
Description

Tests if a ResourceSearchOrder is available.

Returnboolean true if a resource search order is available, false otherwise
Compliancemandatory This method must be implemented.
MethodgetManufacturerSearchOrder
Description

Gets the search order for a manufacturer resource.

Returnosid.resource.ResourceSearchOrder the resource search order
ErrorsUNIMPLEMENTED supportsManufacturerSearchOrder() is false
Complianceoptional This method must be implemented if supportsStockSearchOrder() is true.
MethodorderByArchetype
Description

Specifies a preference for ordering the result set by the archetype.

Parametersosid.SearchOrderStylestyle a search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodorderByNumber
Description

Specifies a preference for ordering the result set by the model number.

Parametersosid.SearchOrderStylestyle a search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodgetModelSearchOrderRecord
Description

Gets the model search order record corresponding to the given model record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TypemodelRecordType a model record type
Returnosid.inventory.records.ModelSearchOrderRecord the model search order record
ErrorsNULL_ARGUMENT modelRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(modelRecordType) is false
Compliancemandatory This method must be implemented.