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

Interface	osid.calendaring.rules.RecurringEventEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Description	This session provides methods to apply `RecurringEventEnablers` to `RecurringEvents.` A `RecurringEvent` with multiple `RecurringEventEnablers` means any positive rule evaluation across the enablers result in an effective `RecurringEvent.`
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	canAssignRecurringEventEnablerRules
Description	Tests if this user can alter recurring event enabler/recurring event mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	assignRecurringEventEnablerToRecurringEvent
Description	Adds an existing `RecurringEventEnabler` to a `RecurringEvent.`
Parameters	`osid.id.Id`	`recurringEventEnablerId`	the `Id` of the `RecurringEventEnabler`
Parameters	`osid.id.Id`	`recurringEventId`	the `Id` of the `RecurringEvent`
Errors	ALREADY_EXISTS		`recurringEventEnablerId` already applied to `recurringEventId`
	NOT_FOUND		`recurringEventEnablerId` or `recurringEventId` not found
	NULL_ARGUMENT		`recurringEventEnablerId` or `recurringEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignRecurringEventEnablerFromRecurringEvent
Description	Removes a `RecurringEventEnabler` from a `RecurringEvent.`
Parameters	`osid.id.Id`	`recurringEventEnablerId`	the `Id` of the `RecurringEventEnabler`
Parameters	`osid.id.Id`	`recurringEventId`	the `Id` of the `RecurringEvent`
Errors	NOT_FOUND		`recurringEventEnablerId` or `recurringEventId` not found or `recurringEventEnablerId` not applied to `recurringEventId`
	NULL_ARGUMENT		`recurringEventEnablerId` or `recurringEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceRecurringEventEnablers
Description	Tests if this user can order `RecurringEventEnablers.` A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.
Return	`boolean`		`false` if `RecurringEventEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveRecurringEventEnablerAhead
Description	Reorders recurring event enablers for a recurring event by moving the specified recurring event enabler in front of a reference recurring event enabler.
Parameters	`osid.id.Id`	`recurringEventEnablerId`	the `Id` of a `RecurringEventEnabler`
	`osid.id.Id`	`recurringEventId`	the `Id` of a `RecurringEvent`
	`osid.id.Id`	`referenceId`	the reference recurring event enabler `Id`
Errors	NOT_FOUND		`recurringEventEnablerId, recurringEventId,` or `referenceId` not found or, `recurringEventEnablerId` or `referenceId` not related to `recurringEventId`
	NULL_ARGUMENT		`recurringEventEnablerId, recurringEventId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveRecurringEventEnablerBehind
Description	Reorders recurring event enablers for a recurring event by moving the specified recurring event enabler behind a reference recurring event enabler.
Parameters	`osid.id.Id`	`recurringEventEnablerId`	the `Id` of a `RecurringEventEnabler`
	`osid.id.Id`	`recurringEventId`	the `Id` of a `RecurringEvent`
	`osid.id.Id`	`referenceId`	the reference recurring event enabler `Id`
Errors	NOT_FOUND		`recurringEventEnablerId, recurringEventId,` or `referenceId` not found or, `recurringEventEnablerId` or `referenceId` not related to `recurringEventId`
	NULL_ARGUMENT		`recurringEventEnablerId, recurringEventId,` or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderRecurringEventEnablers
Description	Reorders a set of recurring event enablers for a recurring event.
Parameters	`osid.id.Id[]`	`recurringEventEnablerIds`	the `Ids` for a set of `RecurringEventEnablers`
Parameters	`osid.id.Id`	`recurringEventId`	the `Id` of a `RecurringEvent`
Errors	NOT_FOUND		`recurringEventEnablerId` not related to `recurringEventId`
	NULL_ARGUMENT		`rceurringEventEnablerIds` or `recurringEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.