OSID Logo
OSID Specifications
osid package
Version 3.0.0
Release Candidate Preview
Interfaceosid.OsidRelationshipSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidTemporalSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByEndReason
Description

Specifies a preference for ordering the results by the end reason state.

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

Tests if a StateSearchOrder is available.

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

Gets the search order for a state.

Returnosid.process.StateSearchOrderthe state search order
ErrorsUNIMPLEMENTED supportsEndReasonSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsEndReasonSearchOrder() is true.