public interface ModelSearchOrder extends OsidObjectSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
ResourceSearchOrder |
getManufacturerSearchOrder()
Gets the search order for a manufacturer resource.
|
ModelSearchOrderRecord |
getModelSearchOrderRecord(Type modelRecordType)
Gets the model search order record corresponding to the given model
record
Type. |
void |
orderByArchetype(SearchOrderStyle style)
Specifies a preference for ordering the result set by the archetype.
|
void |
orderByManufacturer(SearchOrderStyle style)
Specifies a preference for ordering the result set by the
manufacturer.
|
void |
orderByNumber(SearchOrderStyle style)
Specifies a preference for ordering the result set by the model
number.
|
boolean |
supportsManufacturerSearchOrder()
Tests if a
ResourceSearchOrder is available. |
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByManufacturer(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsManufacturerSearchOrder()
ResourceSearchOrder
is available. true
if a resource search order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getManufacturerSearchOrder()
UnimplementedException
-
supportsManufacturerSearchOrder()
is false
optional
- This method must be implemented if
supportsStockSearchOrder()
is true.
void orderByArchetype(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByNumber(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. ModelSearchOrderRecord getModelSearchOrderRecord(Type modelRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.modelRecordType
- a model record typeNullArgumentException
- modelRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(modelRecordType)
is false
mandatory
- This method must be implemented.