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

Interface	osid.calendaring.rules.RecurringEventEnablerLookupSession
Implements	`osid.OsidSession`
Used By	`osid.calendaring.rules.CalendaringRulesManager`
Used By	`osid.calendaring.rules.CalendaringRulesProxyManager`
Description	This session provides methods for retrieving `RecurringEventEnablers`. 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 enabler methods in this session operate, retrieve and pertain to recurring event enablers defined explicitly in the current calendar. Using an isolated view is useful for managing `RecurringEventEnablers` with the `RecurringEventEnablerAdminSession`. federated calendar view: All recurring event enabler methods in this session operate, retrieve and pertain to all recurring event enablers defined in this calendar and any other recurring event enablers implicitly available in this calendar through calendar inheritence. active recurring event enabler view: All recurring event enabler lookup methods return active offset event enablers. any status recurring event enabler view: Recurring event enablers of any active and inactive status are returned from methods. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedDistributorView()` and `useIsolatedDistributorView()` behave as a radio group and one should be selected before invoking the methods in this session.
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	canLookupRecurringEventEnablers
Description	Tests if this user can perform `RecurringEventEnabler` 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	useComparativeRecurringEventEnablerView
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	usePlenaryRecurringEventEnablerView
Description	A complete view of the `RecurringEventEnabler` 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 recurring 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	useActiveRecurringEventEnablerView
Description	Only active recurring event enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusRecurringEventEnablerView
Description	All active and inactive recurring event enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getRecurringEventEnabler
Description	Gets the `RecurringEventEnabler` specified by its `Id`. In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `RecurringEventEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `RecurringEventEnabler` and retained for compatibility. In active mode, recurring event enablers are returned that are currently active. In any status mode, active and inactive recurring event enablers are returned.
Parameters	`osid.id.Id`	`recurringEventEnablerId`	`Id` of the `RecurringEventEnabler`
Return	`osid.calendaring.rules.RecurringEventEnabler`		the recurring event enabler
Errors	NOT_FOUND		`recurringEventEnablerId` not found
	NULL_ARGUMENT		`recurringEventEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getRecurringEventEnablersByIds
Description	Gets a `RecurringEventEnablerList` corresponding to the given `IdList`. In plenary mode, the returned list contains all of the recurring event enablers 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 `RecurringEventEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, recurring event enablers are returned that are currently active. In any status mode, active and inactive recurring event enablers are returned.
Parameters	`osid.id.IdList`	`recurringEventEnablerIds`	the list of `Ids` to retrieve
Return	`osid.calendaring.rules.RecurringEventEnablerList`		the returned `RecurringEventEnablerList` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`recurringEventEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventEnablersByGenusType
Description	Gets a `RecurringEventEnablerListList` corresponding to the given recurring event enabler genus `Type` which does not include recurring event enablers of genus types derived from the specified `Type`. In plenary mode, the returned list contains all known recurring event enablers or an error results. Otherwise, the returned list may contain only those recurring event enablers that are accessible through this session. In active mode, recurring event enablers are returned that are currently active. In any status mode, active and inactive recurring event enablers are returned.
Parameters	`osid.type.Type`	`recurringEventEnablerGenusType`	a recurring event enabler genus type
Return	`osid.calendaring.rules.RecurringEventEnablerList`		the returned `RecurringEventEnablerList` list
Errors	NULL_ARGUMENT		`recurringEventEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventEnablersByParentGenusType
Description	Gets a `RecurringEventEnablerListList` corresponding to the given recurring event enabler genus `Type` and include any additional recurring event enablers with genus types derived from the specified `Type`. In plenary mode, the returned list contains all known recurring event enablers or an error results. Otherwise, the returned list may contain only those recurring event enablers that are accessible through this session. In active mode, recurring event enablers are returned that are currently active. In any status mode, active and inactive recurring event enablers are returned.
Parameters	`osid.type.Type`	`recurringEventEnablerGenusType`	an offset event enabler genus type
Return	`osid.calendaring.rules.RecurringEventEnablerList`		the returned `RecurringEventEnablerList` list
Errors	NULL_ARGUMENT		`recurringEventEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventEnablersByRecordType
Description	Gets a `RecurringEventEnablerList` containing the given recurring event enabler record `Type`. In plenary mode, the returned list contains all known recurring event enablers or an error results. Otherwise, the returned list may contain only those recurring event enablers that are accessible through this session. In active mode, recurring event enablers are returned that are currently active. In any status mode, active and inactive recurring event enablers are returned.
Parameters	`osid.type.Type`	`recurringEventEnablerRecordType`	an offset event enabler record type
Return	`osid.calendaring.rules.RecurringEventEnablerList`		the returned `RecurringEventEnablerList` list
Errors	NULL_ARGUMENT		`ofsetEventEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventEnablersOnDate
Description	Gets a `RecurringEventEnablerListList` effective for the entire the given date range inclusive but not confisned to the date range for any agent. In plenary mode, the returned list contains all known recurring event enablers or an error results. Otherwise, the returned list may contain only those recurring event enablers that are accessible through this session. In active mode, recurring event enablers are returned that are currently active. In any status mode, active and inactive recurring event enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.calendaring.rules.RecurringEventEnablerList`		the returned `RecurringEventEnablerList` 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	getRecurringEventEnablersOnDateWithAgent
Description	Gets a `RecurringEventEnablerListList` effective for the entire the given date range. inclusive but not confisned to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known recurring event enablers or an error results. Otherwise, the returned list may contain only those recurring event enablers that are accessible through this session. In active mode, recurring event enablers are returned that are currently active. In any status mode, active and inactive recurring event enablers are returned.
Parameters	`osid.id.Id`	`agentId`	an agent Id
	`osid.calendaring.DateTime`	`from`	a start date
	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.calendaring.rules.RecurringEventEnablerList`		the returned `RecurringEventEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`agent, from`, or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventEnablers
Description	Gets all `RecurringEventEnablers`. In plenary mode, the returned list contains all known recurring event enablers or an error results. Otherwise, the returned list may contain only those recurring event enablers that are accessible through this session. In active mode, recurring event enablers are returned that are currently active. In any status mode, active and inactive recurring event enablers are returned.
Return	`osid.calendaring.rules.RecurringEventEnablerList`		the returned `RecurringEventEnablerList` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.