OSID - osid.calendaring.EventSearchOrder Service Interface Definition

Interface	osid.calendaring.EventSearchOrder
Implements	`osid.OsidObjectSearchOrder`
	`osid.OsidTemporalSearchOrder`
	`osid.OsidContainableSearchOrder`
Used By	`osid.OsidEnablerSearchOrder`
	`osid.calendaring.CommitmentSearchOrder`
	`osid.calendaring.EventSearchSession`
	`osid.calendaring.EventSmartCalendarSession`
	`osid.calendaring.OffsetEventSearchOrder`
	`osid.calendaring.SupersedingEventSearchOrder`
	`osid.course.CourseOfferingSearchOrder`
	`osid.rules.check.CheckSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderByDuration
Description	Specified a preference for ordering results by the duration. For recurring events, the duration is the duration of a single event.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByRecurringEvent
Description	Specified a preference for ordering results by the recurring event.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsRecurringEventSearchOrder
Description	Tests if a `RecurringEventSearchOrder` is available for recurring events.
Return	`boolean`		`true` if a recurring event search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventSearchOrder
Description	Gets the search order for a recurring event.
Return	`osid.calendaring.RecurringEventSearchOrder`		the recurring event search order
Errors	UNIMPLEMENTED		`supportsRecurringEventSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRecurringEventSearchOrder()` is `true`.
Method	orderBySupersedingEvent
Description	Specified a preference for ordering results by the superseding event.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsSupersedingEventSearchOrder
Description	Tests if a `SupersedingEventSearchOrder` is available for offset events.
Return	`boolean`		`true` if a superseding event search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingEventSearchOrder
Description	Gets the search order for a superseding event.
Return	`osid.calendaring.SupersedingEventSearchOrder`		the superseding event search order
Errors	UNIMPLEMENTED		`supportsSupersedingEventSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSupersedingEventSearchOrder()` is `true`.
Method	orderByOffsetEvent
Description	Specified a preference for ordering results by the offset event.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsOffsetEventSearchOrder
Description	Tests if an `OffsetEventSearchOrder` is available for offset events.
Return	`boolean`		`true` if an offset event search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOffsetEventSearchOrder
Description	Gets the search order for an offset event.
Return	`osid.calendaring.OffsetEventSearchOrder`		the offset event search order
Errors	UNIMPLEMENTED		`supportsOffsetEventSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsOffsetEventSearchOrder()` is `true`.
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	getEventSearchOrderRecord
Description	Gets the event search order record corresponding to the given event record `Type`. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`eventRecordType`	an event record type
Return	`osid.calendaring.records.EventSearchOrderRecord`		the event search order record
Errors	NULL_ARGUMENT		`eventRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(eventRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.