OSID - osid.calendaring.EventLookupSession Service Interface Definition

Interface	osid.calendaring.EventLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Event` 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 event methods in this session operate, retrieve and pertain to events defined explicitly in the current calendar. Using an isolated view is useful for managing events with the `EventAdminSession.` federated calendar view: All event methods in this session operate, retrieve and pertain to all events defined in this calendar and any other calendars implicitly available in this calendar through calendar inheritence. effective event view: All events lookup methods return events where the current date falls in between the effective dates inclusive. any effective event view: Events of any effective date are returned from methods. denormalized event view: recurring events are expanded into a series of non-recurring events normalized event view: recurring events are represented by a single event sequestered event viiew: All event methods suppress sequestered events. unsequestered event view: All event methods return all events. Events may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Event.`
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	canLookupEvents
Description	Tests if this user can perform `Event` 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	useComparativeEventView
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	usePlenaryEventView
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	useEffectiveEventView
Description	Only events whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveEventView
Description	All events of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useNormalizedEventView
Description	A normalized view uses a single `Event` to represent a set of recurring events.
Compliance	`mandatory`		This method is must be implemented.
Method	useDenormalizedEventView
Description	A denormalized view expands recurring events into a series of `Events.`
Compliance	`mandatory`		This method is must be implemented.
Method	useSequesteredEventView
Description	The returns from the lookup methods omit sequestered events.
Compliance	`mandatory`		This method is must be implemented.
Method	useUnsequesteredEventView
Description	All events are returned including sequestered events.
Compliance	`mandatory`		This method is must be implemented.
Method	getEvent
Description	Gets the `Event` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Event` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `Event` and retained for compatibility. In normalized mode, recurring events appear as a single event. In denormalized mode, each element in the recurring series appears as a separate event. In effective mode, events are returned that are currently effective. In any effective mode, effective events and those currently expired are returned. In sequestered mode, no sequestered events are returned. In unsequestered mode, all events are returned.
Parameters	`osid.id.Id`	`eventId`	`Id` of the `Event`
Return	`osid.calendaring.Event`		the event
Errors	NOT_FOUND		`eventId` not found
	NULL_ARGUMENT		`eventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getEventsByIds
Description	Gets an `EventList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the events specified 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. In normalized mode, recurring events appear as a single event. In denormalized mode, each element in the recurring series appears as a separate event. In effective mode, events are returned that are currently effective. In any effective mode, effective events and those currently expired are returned. In sequestered mode, no sequestered events are returned. In unsequestered mode, all events are returned.
Parameters	`osid.id.IdList`	`eventIds`	the list of `Ids` to retrieve
Return	`osid.calendaring.EventList`		the returned `Event` 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	getEventsByGenusType
Description	Gets an `EventList` corresponding to the given event genus `Type` which does not include events of genus types derived from the specified `Type.` 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 normalized mode, recurring events appear as a single event. In denormalized mode, each element in the recurring series appears as a separate event. In effective mode, events are returned that are currently effective. In any effective mode, effective events and those currently expired are returned. In sequestered mode, no sequestered events are returned. In unsequestered mode, all events are returned.
Parameters	`osid.type.Type`	`eventGenusType`	an event genus type
Return	`osid.calendaring.EventList`		the returned `Event` list
Errors	NULL_ARGUMENT		`eventGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEventsByParentGenusType
Description	Gets an `EventList` corresponding to the given event genus `Type` and include any additional event with genus types derived from the specified `Type.` 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 normalized mode, recurring events appear as a single event. In denormalized mode, each element in the recurring series appears as a separate event. In effective mode, events are returned that are currently effective. In any effective mode, effective events and those currently expired are returned. In sequestered mode, no sequestered events are returned. In unsequestered mode, all events are returned.
Parameters	`osid.type.Type`	`eventGenusType`	an event genus type
Return	`osid.calendaring.EventList`		the returned `Event` list
Errors	NULL_ARGUMENT		`eventGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEventsByRecordType
Description	Gets an `EventList` containing the given event record `Type.` 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 normalized mode, recurring events appear as a single event. In denormalized mode, each element in the recurring series appears as a separate event. In effective mode, events are returned that are currently effective. In any effective mode, effective events and those currently expired are returned.
Parameters	`osid.type.Type`	`eventRecordType`	an event record type
Return	`osid.calendaring.EventList`		the returned `Event` list
Errors	NULL_ARGUMENT		`eventRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEventsOnDate
Description	Gets a list of events where the given date range falls within an event inclusive. 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 normalized mode, recurring events appear as a single event. In denormalized mode, each element in the recurring series appears as a separate event. In effective mode, events are returned that are currently effective. In any effective mode, effective events and those currently expired are returned. In sequestered mode, no sequestered events are returned. In unsequestered mode, all events are returned.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
Parameters	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.calendaring.EventList`		the returned `Event` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	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	getEventsInDateRange
Description	Gets an `EventList` that fall within the given range inclusive `.` 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 normalized mode, recurring events appear as a single event. In denormalized mode, each element in the recurring series appears as a separate event. In effective mode, events are returned that are currently effective. In any effective mode, effective events and those currently expired are returned. In sequestered mode, no sequestered events are returned. In unsequestered mode, all events are returned.
Parameters	`osid.calendaring.DateTime`	`from`	start date
Parameters	`osid.calendaring.DateTime`	`to`	end date
Return	`osid.calendaring.EventList`		the returned `Event` 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	getUpcomingEvents
Description	Gets the next upcoming events on this calendar. 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 normalized mode, recurring events appear as a single event. In denormalized mode, each element in the recurring series appears as a separate event. In effective mode, events are returned that are currently effective. In any effective mode, effective events and those currently expired are returned. In sequestered mode, no sequestered events are returned. In unsequestered mode, all events are returned.
Parameters	`cardinal`	`number`	the number of events
Return	`osid.calendaring.EventList`		the returned `Event` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEventsByLocation
Description	Gets a list of events with the given location. 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 normalized mode, recurring events appear as a single event. In denormalized mode, each element in the recurring series appears as a separate event. In effective mode, events are returned that are currently effective. In any effective mode, effective events and those currently expired are returned. In sequestered mode, no sequestered events are returned. In unsequestered mode, all events are returned.
Parameters	`osid.id.Id`	`locationId`	a location
Return	`osid.calendaring.EventList`		the returned `Event` list
Errors	NULL_ARGUMENT		`locationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEventsByLocationOnDate
Description	Gets an `EventList` at the given location where the given date range falls within the event dates inclusive. 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 normalized mode, recurring events appear as a single event. In denormalized mode, each element in the recurring series appears as a separate event. In effective mode, events are returned that are currently effective. In any effective mode, effective events and those currently expired are returned. In sequestered mode, no sequestered events are returned. In unsequestered mode, all events are returned.
Parameters	`osid.id.Id`	`locationId`	a location
	`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`
	NULL_ARGUMENT		`locationId, from` , or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEventsByLocationInDateRange
Description	Gets an `EventList` that fall within the given range inclusive at the given location `.` 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 normalized mode, recurring events appear as a single event. In denormalized mode, each element in the recurring series appears as a separate event. In effective mode, events are returned that are currently effective. In any effective mode, effective events and those currently expired are returned. In sequestered mode, no sequestered events are returned. In unsequestered mode, all events are returned.
Parameters	`osid.id.Id`	`locationId`	a location
	`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`
	NULL_ARGUMENT		`locationId, from` , or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEventsBySponsor
Description	Gets a list of events with the given sponsor. 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 normalized mode, recurring events appear as a single event. In denormalized mode, each element in the recurring series appears as a separate event. In effective mode, events are returned that are currently effective. In any effective mode, effective events and those currently expired are returned. In sequestered mode, no sequestered events are returned. In unsequestered mode, all events are returned.
Parameters	`osid.id.Id`	`resourceId`	a sponsor
Return	`osid.calendaring.EventList`		the returned `Event` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEventsBySponsorOnDate
Description	Gets an `EventList` with the given sponsor where the given date range falls within the event dates inclusive. 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 normalized mode, recurring events appear as a single event. In denormalized mode, each element in the recurring series appears as a separate event. In effective mode, events are returned that are currently effective. In any effective mode, effective events and those currently expired are returned. In sequestered mode, no sequestered events are returned. In unsequestered mode, all events are returned.
Parameters	`osid.id.Id`	`resourceId`	a sponsor
	`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`
	NULL_ARGUMENT		`resourceId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEventsBySponsorInDateRange
Description	Gets an `EventList` that fall within the given range inclusive at the given location `.` 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 normalized mode, recurring events appear as a single event. In denormalized mode, each element in the recurring series appears as a separate event. In effective mode, events are returned that are currently effective. In any effective mode, effective events and those currently expired are returned. In sequestered mode, no sequestered events are returned. In unsequestered mode, all events are returned.
Parameters	`osid.id.Id`	`resourceId`	a sponsor
	`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`
	NULL_ARGUMENT		`resourceId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEvents
Description	Gets all `Events.` 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 normalized mode, recurring events appear as a single event. In denormalized mode, each element in the recurring series appears as a separate event. In effective mode, events are returned that are currently effective. In any effective mode, effective events and those currently expired are returned. In sequestered mode, no sequestered events are returned. In unsequestered mode, all events are returned.
Return	`osid.calendaring.EventList`		an `EventList`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.