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

Interface	osid.calendaring.rules.OffsetEventEnablerRuleLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `OffsetEventEnabler` to `OffsetEvent` mappings. An `Calendar` with multiple `OffsetEventEnablers` means any positive rule evaluation across the enablers result in an effective `OffsetEvent.` 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 isolated calendar view: All methods in this session operate, retrieve and pertain offset event enablers defined explicitly in the current calendar federated calendar view: All methods in this session operate, retrieve and pertain to all offset event enablers defined in this calendar and any other offset event enablers 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
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupOffsetEventEnablerRules
Description	Tests if this user can perform lookups of offset event enabler/offset event 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	useComparativeOffsetEventEnablerRuleView
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	usePlenaryOffsetEventEnablerRuleView
Description	A complete view of the `OffsetEventEnabler` and `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 event enablers 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	getOffsetEventEnablerIdsForOffsetEvent
Description	Gets the `OffsetEventEnabler Id` associated with an `OffsetEvent.`
Parameters	`osid.id.Id`	`offsetEventId`	`Id` of the `OffsetEvent`
Return	`osid.id.IdList`		the offset event enabler `Ids`
Errors	NOT_FOUND		`offsetEventId` is not found
	NULL_ARGUMENT		`offsetEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOffsetEventEnablersForOffsetEvent
Description	Gets the `OffsetEventEnablers` associated with an `OffsetEvent.`
Parameters	`osid.id.Id`	`offsetEventId`	`Id` of the `OffsetEvent`
Return	`osid.calendaring.rules.OffsetEventEnablerList`		the offset event enablers
Errors	NOT_FOUND		`offsetEventId` is not found
	NULL_ARGUMENT		`offsetEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOffsetEventIdsForOffsetEventEnabler
Description	Gets the `OffsetEvent` `Ids` mapped to an `OffsetEventEnabler.`
Parameters	`osid.id.Id`	`offsetEventEnablerId`	`Id` of an `OffsetEventEnabler`
Return	`osid.id.IdList`		list of offset event `Ids`
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	getOffsetEventsForOffsetEventEnabler
Description	Gets the `OffsetEvents` mapped to an `OffsetEventEnabler.`
Parameters	`osid.id.Id`	`offsetEventEnablerId`	`Id` of an `OffsetEventEnabler`
Return	`osid.calendaring.OffsetEventList`		list of offset events
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.