OSID - osid.calendaring.OffsetEventLookupSession Service Interface Definition

Interface	osid.calendaring.OffsetEventLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `OffsetEvents.` 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 offset event methods in this session operate, retrieve and pertain to offset events defined explicitly in the current calendar. Using an isolated view is useful for managing events with the `OffsetEventAdminSession.` federated calendar view: All offset event methods in this session operate, retrieve and pertain to all offset events defined in this calendar and any other calendars implicitly available in this calendar through calendar inheritence. active offset event view: All offset event lookup methods return active offset events. any status offset event view: Offset events of any active or inactive status are returned from methods.
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	canLookupOffsetEvents
Description	Tests if this user can perform `OffsetEvent` 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	useComparativeOffsetEventView
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	usePlenaryOffsetEventView
Description	A complete view of the `OffsetEvent` 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 offset 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	useActiveOffsetEventView
Description	Only active offset events are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusOffsetEventView
Description	All active and inactive offset events are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getOffsetEvent
Description	Gets the `OffsetEvent` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `OffsetEvent` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `OffsetEvent` and retained for compatibility. In active mode, offset events are returned that are currently active. In any status mode, active and inactive offset events are returned.
Parameters	`osid.id.Id`	`offsetEventId`	`Id` of the `OffsetEvent`
Return	`osid.calendaring.OffsetEvent`		the offset event
Errors	NOT_FOUND		`offsetEventId` not found
	NULL_ARGUMENT		`offsetEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getOffsetEventsByIds
Description	Gets an `OffsetEventList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the offset 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 `OffsetEvents` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, offset events are returned that are currently active. In any status mode, active and inactive offset events are returned.
Parameters	`osid.id.IdList`	`offsetEventIds`	the list of `Ids` to retrieve
Return	`osid.calendaring.OffsetEventList`		the returned `OffsetEvent` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`offsetEventIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOffsetEventsByGenusType
Description	Gets an `OffsetEventList` corresponding to the given offset event genus `Type` which does not include offset events of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known offset events or an error results. Otherwise, the returned list may contain only those offset events that are accessible through this session. In active mode, offset events are returned that are currently active. In any status mode, active and inactive offset events are returned.
Parameters	`osid.type.Type`	`offsetEventGenusType`	an offset event genus type
Return	`osid.calendaring.OffsetEventList`		the returned `OffsetEvent` list
Errors	NULL_ARGUMENT		`offsetEventGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOffsetEventsByParentGenusType
Description	Gets an `OffsetEventList` corresponding to the given offset event genus `Type` and include any additional offset event with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known offset events or an error results. Otherwise, the returned list may contain only those offset events that are accessible through this session. In active mode, offset events are returned that are currently active. In any status mode, active and inactive offset events are returned.
Parameters	`osid.type.Type`	`offsetEventGenusType`	an offset event genus type
Return	`osid.calendaring.OffsetEventList`		the returned `OffsetEvent` list
Errors	NULL_ARGUMENT		`offsetEventGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOffsetEventsByRecordType
Description	Gets an `OffsetEventList` containing the given offset event record `Type.` In plenary mode, the returned list contains all known offset events or an error results. Otherwise, the returned list may contain only those offset events that are accessible through this session. In active mode, offset events are returned that are currently active. In any status mode, active and inactive offset events are returned.
Parameters	`osid.type.Type`	`offsetEventrecordType`	an offset event record type
Return	`osid.calendaring.OffsetEventList`		the returned `OffsetEvent` list
Errors	NULL_ARGUMENT		`offsetEventRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOffsetEventsByEvent
Description	Gets the `OffsetEvents` using the given event as a start or ending offset. In plenary mode, the returned list contains all known offset events or an error results. Otherwise, the returned list may contain only those offset events that are accessible through this session. In active mode, offset events are returned that are currently active. In any status mode, active and inactive offset events are returned.
Parameters	`osid.id.Id`	`eventId`	`Id` of the related event
Return	`osid.calendaring.OffsetEventList`		the offset events
Errors	NULL_ARGUMENT		`eventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getOffsetEvents
Description	Gets all `OffsetEvents.` In plenary mode, the returned list contains all known offset events or an error results. Otherwise, the returned list may contain only those offset events that are accessible through this session. In active mode, offset events are returned that are currently active. In any status mode, active and inactive offset events are returned.
Return	`osid.calendaring.OffsetEventList`		an `OffsetEventList`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.