Interface | osid.inventory.ModelSearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByManufacturer | ||
Description |
Specifies a preference for ordering the result set by the manufacturer. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsManufacturerSearchOrder | ||
Description |
Tests if a | ||
Return | boolean | true if a resource search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getManufacturerSearchOrder | ||
Description |
Gets the search order for a manufacturer resource. | ||
Return | osid.resource.ResourceSearchOrder | the resource search order | |
Errors | UNIMPLEMENTED | supportsManufacturerSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsStockSearchOrder()
is true. | |
Method | orderByArchetype | ||
Description |
Specifies a preference for ordering the result set by the archetype. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByNumber | ||
Description |
Specifies a preference for ordering the result set by the model number. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getModelSearchOrderRecord | ||
Description |
Gets the model search order record corresponding to the
given model record | ||
Parameters | osid.type.Type | modelRecordType | a model record type |
Return | osid.inventory.records.ModelSearchOrderRecord | the model search order 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. |