OSID - osid.calendaring.RecurringEventUnravellingSession Service Interface Definition

Interface	osid.calendaring.RecurringEventUnravellingSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving and expanding `RecurringEvent` s. This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated calendar view: All recurring event methods in this session operate, retrieve and pertain to recurring events defined explicitly in the current calendar. Using an isolated view is useful for managing recurring events with the `RecurringEventAdminSession.` federated calendar view: All recurring event methods in this session operate, retrieve and pertain to all recurring events defined in this calendar and any other calendars implicitly available in this calendar through calendar inheritence.
Method	getCalendarId
Description	Gets the `Calendar` `Id` associated with this session.
Return	`osid.id.Id`		the `Calendar Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCalendar
Description	Gets the `Calendar` associated with this session.
Return	`osid.calendaring.Calendar`		the `Calendar` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canUnravelRecurringEvents
Description	Tests if this user can perform `RecurringEvent` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeRecurringEventView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryRecurringEventView
Description	A complete view of the `Event` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedCalendarView
Description	Federates the view for methods in this session. A federated view will include events in calendars which are children of this calendar in the calendar hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCalendarView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this calendar only.
Compliance	`mandatory`		This method is must be implemented.
Method	getRecurringEventByEvent
Description	Gets the recurring event where the given event `Id` was issued as part of the recurring series.
Parameters	`osid.id.Id`	`eventId`	`an event Id`
Return	`osid.calendaring.RecurringEvent`		the returned `RecurringEvent`
Errors	NOT_FOUND		`eventId` is not found
	NULL_ARGUMENT		`eventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventsByEvents
Description	Gets a `RecurringEventList` corresponding to the given event `IdList` where the events were implcitly created from the recurring series. In plenary mode, the returned list contains all of the recurring events corresponding to the events in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Events` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`eventIds`	the list of `Ids` to retrieve
Return	`osid.calendaring.RecurringEventList`		the returned `RecurringEvent` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`eventIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	expandRecurringEvent
Description	Expands the given recurring event into a series of non-recurring events. In plenary mode, the returned list contains all of the events in the series, including duplicates, or an error results. In comparative mode, events may be omitted from the list and may present the elements in any order, including providing a unique set.
Parameters	`osid.id.Id`	`recurringEventId`	`Id` of the recurring `Event`
Return	`osid.calendaring.EventList`		the returned `Event list`
Errors	NOT_FOUND		`recurringEventId was` not found
	NULL_ARGUMENT		`recurringEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	expandRecurringEventInDateRange
Description	Expands the given recurring event into a series of non-recurring events that fall within the given date range inclusive. In plenary mode, the returned list contains all of the events in the series, including duplicates, or an error results. In comparative mode, events may be omitted from the list and may present the elements in any order, including providing a unique set.
Parameters	`osid.id.Id`	`recurringEventId`	`Id` of the recurring `Event`
	`osid.calendaring.DateTime`	`from`	start date
	`osid.calendaring.DateTime`	`to`	end date
Return	`osid.calendaring.EventList`		the returned `Event list`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NOT_FOUND		`recurringEventId was` not found
	NULL_ARGUMENT		`recurringEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	expandRecurringEvents
Description	Expands the given recurring events into a series of non-recurring events. In plenary mode, the returned list contains all of the events in the series, including duplicates, or an error results. In comparative mode, events may be omitted from the list and may present the elements in any order, including providing a unique set.
Parameters	`osid.id.IdList`	`recurringEventIds`	the list of `Ids` to expand
Return	`osid.calendaring.EventList`		the returned `Event list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`recurringEventIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	expandRecurringEventsInDateRange
Description	Expands the given recurring events into a series of non-recurring events that fall within the given date range inclusive. In plenary mode, the returned list contains all of the events in the series, including duplicates, or an error results. In comparative mode, events may be omitted from the list and may present the elements in any order, including providing a unique set.
Parameters	`osid.id.Id`	`recurringEventIds`	the list of `Ids` to expand
	`osid.calendaring.DateTime`	`from`	start date
	`osid.calendaring.DateTime`	`to`	end date
Return	`osid.calendaring.EventList`		the returned `Event list`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`recurringEventIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getRecurringEventsByDate
Description	Gets a list of recurring events where the given date falls within the span of a recurring event. In plenary mode, the returned list contains all known events or an error results. Otherwise, the returned list may contain only those events that are accessible through this session. In both cases, the order of the set is not specified.
Parameters	`osid.calendaring.DateTime`	`datetime`	a date
Return	`osid.calendaring.RecurringEventList`		the returned `RecurringEvent` list
Errors	NULL_ARGUMENT		`datetime` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventsInDateRange
Description	Gets a `RecurringEventList` whose series falls entirely within the given range inclusive `.` In plenary mode, the returned list contains all known recurring events or an error results. Otherwise, the returned list may contain only those recurring events that are accessible through this session. In both cases, the order of the set is not specified.
Parameters	`osid.calendaring.DateTime`	`from`	start date
Parameters	`osid.calendaring.DateTime`	`to`	end date
Return	`osid.calendaring.RecurringEventList`		the returned `RecurringEvent` list
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getNumberOfEvents
Description	Gets the number of events in the recurring series.
Parameters	`osid.id.Id`	`recurringEventId`	`Id` of the recurring `Event`
Return	`cardinal`		the number of meeting times
Errors	NOT_FOUND		`recurringEventId was` not found
	NULL_ARGUMENT		`recurringEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getNumberOfEventsInDateRange
Description	Gets the number of events in the recurring series between the given dates inclusive.
Parameters	`osid.id.Id`	`recurringEventId`	`Id` of the recurring `Event`
	`osid.calendaring.DateTime`	`from`	start date
	`osid.calendaring.DateTime`	`to`	end date
Return	`cardinal`		the number of meeting times
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NOT_FOUND		`recurringEventId was` not found
	NULL_ARGUMENT		`recurringEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.