OSID - osid.calendaring.rules.OffsetEventEnablerCalendarSession Service Interface Definition

Interface	osid.calendaring.rules.OffsetEventEnablerCalendarSession
Implements	`osid.OsidSession`
Used By	`osid.calendaring.rules.CalendaringRulesManager`
Used By	`osid.calendaring.rules.CalendaringRulesProxyManager`
Description	This session provides methods to retrieve `OffsetEventEnabler` to `Calendar` mappings. An `OffsetEventEnabler` may appear in multiple `Calendar` objects. Each calendar may have its own authorizations governing who is allowed to look at it. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition
Method	canLookupOffsetEventEnablerCalendarMappings
Description	Tests if this user can perform lookups of offset event enabler/calendar mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeOffsetEventEnablerCalendarView
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	usePlenaryOffsetEventEnablerCalendarView
Description	A complete view of the `OffsetEventEnabler` and `Calendar` 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	getOffsetEventEnablerIdsByCalendar
Description	Gets the list of `OffsetEventEnablerIds` associated with a `Calendar`.
Parameters	`osid.id.Id`	`calendarId`	`Id` of the `Calendar`
Return	`osid.id.IdList`		list of related offset event enabler `Ids`
Errors	NOT_FOUND		`calendarId` is not found
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOffsetEventEnablersByCalendar
Description	Gets the list of offset event enablers associated with a `Calendar`.
Parameters	`osid.id.Id`	`calendarId`	`Id` of the `Calendar`
Return	`osid.calendaring.rules.OffsetEventEnablerList`		list of related offset event enablers
Errors	NOT_FOUND		`calendarId` is not found
	NULL_ARGUMENT		`calendarId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOffsetEventEnablerIdsByCalendars
Description	Gets the list of `OffsetEventEnablerIds` corresponding to a list of `Calendars`.
Parameters	`osid.id.IdList`	`calendarIds`	list of calendar `Ids`
Return	`osid.id.IdList`		list of offset event enabler `Ids`
Errors	NULL_ARGUMENT		`calendarIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOffsetEventEnablersByCalendars
Description	Gets the list of offset event enablers corresponding to a list of `Calendars`.
Parameters	`osid.id.IdList`	`calendarIds`	list of calendar `Ids`
Return	`osid.calendaring.rules.OffsetEventEnablerList`		list of offset event enablers
Errors	NULL_ARGUMENT		`calendarIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCalendarIdsByOffsetEventEnabler
Description	Gets the `Calendar` `Ids` mapped to an `OffsetEventEnabler`.
Parameters	`osid.id.Id`	`offsetEventEnablerId`	`Id` of an `OffsetEventEnabler`
Return	`osid.id.IdList`		list of calendars
Errors	NOT_FOUND		`offsetEventEnablerId` is not found
	NULL_ARGUMENT		`offsetEventEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCalendarsByOffsetEventEnabler
Description	Gets the `Calendars` mapped to an `OffsetEventEnabler`.
Parameters	`osid.id.Id`	`offsetEventEnablerId`	`Id` of an `OffsetEventEnabler`
Return	`osid.calendaring.CalendarList`		list of calendars
Errors	NOT_FOUND		`offsetEventEnablerId` is not found
	NULL_ARGUMENT		`offsetEventEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.