OSID Logo
OSID Specifications
osid package
Version 3.0.0
Release Candidate Preview
Interfaceosid.OsidObjectSearchOrder
Implementsosid.OsidIdentifiableSearchOrder
osid.OsidExtensibleSearchOrder
osid.OsidBrowsableSearchOrder
Description

OsidObjectSearchOrder specifies preferred ordering of search results. An OsidSearchOrder is available from an search session and supplied to an OsidSearch.

                     
                     
                     OsidObjectSearch os = session.getObjectSearch();
                     os.limitResultSet(1, 25);
                     
                     OsidObjectSearchOrder order = session.getObjectSearchOrder();
                     order.orderByDisplayName();
                     os.orderResults(order);
                     
                     OsidObjectQuery query;
                     query = session.getObjectQuery();
                     query.addDescriptionMatch("*food*", wildcardStringMatchType, true);
                     
                     ObjectSearchResults results = session.getObjectsBySearch(query, os);
                     ObjectList list = results.getObjectList();
                     
                                 
                     
                
MethodorderByDisplayName
Description

Specifies a preference for ordering the result set by the display name.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByDescription
Description

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

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByGenusType
Description

Specifies a preference for ordering the result set by the genus type.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByState
Description

Orders by the state in a given Process.

Parametersosid.id.IdprocessIda process Id
osid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT processId or style is null
CompliancemandatoryThis method must be implemented.
MethodorderByCumulativeRating
Description

Orders by the cumulative rating in a given Book.

Parametersosid.id.IdbookIda book Id
osid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT bookId or style is null
CompliancemandatoryThis method must be implemented.
MethodorderByStatistic
Description

Orders by a statistic for a given Meter.

Parametersosid.id.IdmeterIda meter Id
osid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT meterId or style is null
CompliancemandatoryThis method must be implemented.
MethodorderByCreateTime
Description

Orders by the timestamp of the first journal entry.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByLastModifiedTime
Description

Orders by the timestamp of the last journal entry.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.