OSID - osid.calendaring.OffsetEventSearchOrder Service Interface Definition

Interface	osid.calendaring.OffsetEventSearchOrder
Implements	`osid.OsidRuleSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderByFixedStartTime
Description	Specified a preference for ordering results by the fixed start time.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByStartReferenceEvent
Description	Specified a preference for ordering results by the starting reference event.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsStartReferenceEventSearchOrder
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	getStartReferenceEventSearchOrder
Description	Gets the search order for an event.
Return	`osid.calendaring.EventSearchOrder`		the event search order
Errors	UNIMPLEMENTED		`supportsStartReferenceEventSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStartReferenceEventSearchOrder()` is `true.`
Method	orderByFixedStartOffset
Description	Specified a preference for ordering results by the fixed offset.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByRelativeWeekdayStartOffset
Description	Specified a preference for ordering results by the relative weekday offset.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByRelativeStartWeekday
Description	Specified a preference for ordering results by the relative weekday.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByFixedDuration
Description	Specified a preference for ordering results by the fixed duration.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByEndReferenceEvent
Description	Specified a preference for ordering results by the ending reference event.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsEndReferenceEventSearchOrder
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	getEndReferenceEventSearchOrder
Description	Gets the search order for an event.
Return	`osid.calendaring.EventSearchOrder`		the event search order
Errors	UNIMPLEMENTED		`supportsEndReferenceEventSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEndReferenceEventSearchOrder()` is `true.`
Method	orderByFixedEndOffset
Description	Specified a preference for ordering results by the fixed offset.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByRelativeWeekdayEndOffset
Description	Specified a preference for ordering results by the relative weekday offset.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByRelativeEndWeekday
Description	Specified a preference for ordering results by the relative weekday.
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	getOffsetEventSearchOrderRecord
Description	Gets the offset event search order record corresponding to the given offset event record `Type.` Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`offsetEventRecordType`	an offset event record type
Return	`osid.calendaring.records.OffsetEventSearchOrderRecord`		the offset event search order record
Errors	NULL_ARGUMENT		`offsetEventRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(offsetEventRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.