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

Interface	osid.calendaring.rules.RecurringEventEnablerAdminSession
Implements	`osid.OsidSession`
Description	This session creates and removes recurring event enablers. The data for create and update is provided via the `RecurringEventEnablerForm.`
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	canCreateRecurringEventEnabler
Description	Tests if this user can create recurring event enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `RecurringEventEnabler` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `RecurringEventEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRecurringEventEnablerWithRecordTypes
Description	Tests if this user can create a single `RecurringEventEnabler` using the desired record types. While `CalendarRulesManager.getRecurringEventEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `RecurringEventEnabler.` Providing an empty array tests if a `RecurringEventEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`recurringEventEnablerRecordTypes`	array of recurring event enabler record types
Return	`boolean`		`true` if `RecurringEventEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`recurringEventEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventEnablerFormForCreate
Description	Gets the recurring event enabler form for creating new recurring event enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`recurringEventEnablerRecordTypes`	array of recurring event enabler record types
Return	`osid.calendaring.rules.RecurringEventEnablerForm`		the recurring event enabler form
Errors	NULL_ARGUMENT		`recurringEventEnablerRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createRecurringEventEnabler
Description	Creates a new `RecurringEventEnabler.`
Parameters	`osid.calendaring.rules.RecurringEventEnablerForm`	`recurringEventEnablerForm`	the form for this `RecurringEventEnabler`
Return	`osid.calendaring.rules.RecurringEventEnabler`		the new `RecurringEventEnabler`
Errors	ILLEGAL_STATE		`recurringEventEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`recurringEventEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`recurringEventEnablerForm` did not originate from `getRecurringEventEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateRecurringEventEnablers
Description	Tests if this user can update recurring event enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `RecurringEventEnabler` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `RecurringEventEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventEnablerFormForUpdate
Description	Gets the recurring event enabler form for updating an existing recurring event enabler. A new recurring event enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`recurringEventEnablerId`	the `Id` of the `RecurringEventEnabler`
Return	`osid.calendaring.rules.RecurringEventEnablerForm`		the recurring event enabler form
Errors	NOT_FOUND		`recurringEventEnablerId` is not found
	NULL_ARGUMENT		`recurringEventEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateRecurringEventEnabler
Description	Updates an existing recurring event enabler.
Parameters	`osid.calendaring.rules.RecurringEventEnablerForm`	`recurringEventEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`recurringEventEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`recurringEventEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`recurringEventEnablerForm` did not originate from `getRecurringEventEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteEventEnablers
Description	Tests if this user can delete recurring event enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `RecurringEventEnabler` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `RecurringEventEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteEventEnabler
Description	Deletes a `RecurringEventEnabler.`
Parameters	`osid.id.Id`	`recurringEventEnablerId`	the `Id` of the `RecurringEventEnabler` to remove
Errors	NOT_FOUND		`recurrintEventEnablerId` not found
	NULL_ARGUMENT		`recurringEventEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageEventEnablerAliases
Description	Tests if this user can manage `Id` aliases for recurring event enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`true` if `RecurringEventEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasEventEnabler
Description	Adds an `Id` to a `RecurringEventEnabler` for the purpose of creating compatibility. The primary `Id` of the `RecurringEventEnabler` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another recurring event enabler. it is reassigned to the given recurring event enabler `Id.`
Parameters	`osid.id.Id`	`recurringEventEnablerId`	the `Id` of a `RecurringEventEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`recurringEventEnablerId` not found
	NULL_ARGUMENT		`recurringEventEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.