OSID Logo
OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.ModelSearchOrder
Implementsosid.OsidObjectSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByManufacturer
Description

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

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsManufacturerSearchOrder
Description

Tests if a ResourceSearchOrder is available.

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

Gets the search order for a manufacturer resource.

Returnosid.resource.ResourceSearchOrderthe resource search order
ErrorsUNIMPLEMENTED supportsManufacturerSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsStockSearchOrder() is true.
MethodorderByArchetype
Description

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

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByNumber
Description

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

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis 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.TypemodelRecordTypea model record type
Returnosid.inventory.records.ModelSearchOrderRecordthe model search order record
ErrorsNULL_ARGUMENT modelRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(modelRecordType) is false
CompliancemandatoryThis method must be implemented.