OSID - osid.calendaring.ScheduleSearchOrder Service Interface Definition

Interface	osid.calendaring.ScheduleSearchOrder
Implements	`osid.OsidObjectSearchOrder`
Used By	`osid.OsidEnablerSearchOrder`
	`osid.calendaring.ScheduleSearchSession`
	`osid.calendaring.ScheduleSmartCalendarSession`
Description	An interface for specifying the ordering of search results.
Method	orderByScheduleSlot
Description	Specified a preference for ordering results by the schedule slot.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsScheduleSlotSearchOrder
Description	Tests if a `ScheduleSlotSearchOrder` is available.
Return	`boolean`		`true` if a schedule slot search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleSlotSearchOrder
Description	Gets the search order for the schedule slot.
Return	`osid.calendaring.ScheduleSlotSearchOrder`		the schdeule slot search order
Errors	UNIMPLEMENTED		`supportsScheduleSlotSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsScheduleSlotSearchOrder()` is `true`.
Method	orderByTimePeriod
Description	Specified a preference for ordering results by the time period.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsTimePeriodSearchOrder
Description	Tests if a `TimePeriodSearchOrder` is available.
Return	`boolean`		`true` if a time period search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodSearchOrder
Description	Gets the search order for the time period.
Return	`osid.calendaring.TimePeriodSearchOrder`		the time period search order
Errors	UNIMPLEMENTED		`supportsTimePeriodSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTimePeriodSearchOrder()` is `true`.
Method	orderByScheduleStart
Description	Specified a preference for ordering results by the schedule start.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByScheduleEnd
Description	Specified a preference for ordering results by the schedule end.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByTotalDuration
Description	Specified a preference for ordering results by the schedule duration.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByLimit
Description	Specified a preference for ordering results by the occurrence limit.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByLocationDescription
Description	Specified a preference for ordering results by the location description.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByLocation
Description	Specified a preference for ordering results by the location.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsLocationSearchOrder
Description	Tests if a `LocationSearchOrder` is available.
Return	`boolean`		`true` if a location search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLocationSearchOrder
Description	Gets the search order for a location.
Return	`osid.mapping.LocationSearchOrder`		the location search order
Errors	UNIMPLEMENTED		`supportsLocationSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLocationSearchOrder()` is `true`.
Method	getScheduleSearchOrderRecord
Description	Gets the schedule search order record corresponding to the given schedule record `Type`.Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`scheduleRecordType`	a schedule record type
Return	`osid.calendaring.records.ScheduleSearchOrderRecord`		the schedule search order record
Errors	NULL_ARGUMENT		`scheduleRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(scheduleRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.