OSID - osid.OsidEnablerSearchOrder Service Interface Definition

Interface	osid.OsidEnablerSearchOrder
Implements	`osid.OsidRuleSearchOrder`
Implements	`osid.OsidTemporalSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderBySchedule
Description	Specifies a preference for ordering the results by the associated schedule.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsScheduleSearchOrder
Description	Tests if a `ScheduleSearchOrder` is available.
Return	`boolean`		`true` if a schedule search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleSearchOrder
Description	Gets the search order for a schedule.
Return	`osid.calendaring.ScheduleSearchOrder`		the schedule search order
Errors	UNIMPLEMENTED		`supportsScheduleSearchOrder() is false`
Compliance	`optional`		This method must be implemented if `supportsScheduleSearchOrder()` is true.
Method	orderByEvent
Description	Specifies a preference for ordering the results by the associated event.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsEventSearchOrder
Description	Tests if an `EventSearchOrder` is available.
Return	`boolean`		`true` if an event search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEventSearchOrder
Description	Gets the search order for an event.
Return	`osid.calendaring.EventSearchOrder`		the event search order
Errors	UNIMPLEMENTED		`supportsEventSearchOrder() is false`
Compliance	`optional`		This method must be implemented if `supportsEventSearchOrder()` is true.
Method	orderByCyclicEvent
Description	Orders the results by cyclic event.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCyclicEventSearchOrder
Description	Tests if a cyclic event search order is available.
Return	`boolean`		`true` if a cyclic event search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicEventSearchOrder
Description	Gets the cyclic event search order.
Return	`osid.calendaring.cycle.CyclicEventSearchOrder`		the cyclic event search order
Errors	ILLEGAL_STATE		`supportsCyclicEventSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByDemographic
Description	Specifies a preference for ordering the results by the associated demographic resource.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsDemographicSearchOrder
Description	Tests if a `ResourceSearchOrder` is available.
Return	`boolean`		`true` if a resource search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicSearchOrder
Description	Gets the search order for a demographic resource.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Errors	UNIMPLEMENTED		`supportsDemographicSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDemographicSearchOrder()` is `true.`