Interface | osid.OsidRelationshipSearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
osid.OsidTemporalSearchOrder | |||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByEndReason | ||
Description |
Specifies a preference for ordering the results by the end reason state. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsEndReasonSearchOrder | ||
Description |
Tests if a | ||
Return | boolean | true if a state search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getEndReasonSearchOrder | ||
Description |
Gets the search order for a state. | ||
Return | osid.process.StateSearchOrder | the state search order | |
Errors | UNIMPLEMENTED | supportsEndReasonSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsEndReasonSearchOrder()
is true. |