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

Interface	osid.calendaring.rules.SupersedingEventEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.calendaring.rules.CalendaringRulesManager`
Used By	`osid.calendaring.rules.CalendaringRulesProxyManager`
Description	This session creates and removes superseding event enablers. The data for create and update is provided via the `SupersedingEventEnablerForm`.
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	canCreateSupersedingEventEnabler
Description	Tests if this user can create superseding event enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `SupersedingEventEnabler` 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 `SupersedingEventEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateSupersedingEventEnablerWithRecordTypes
Description	Tests if this user can create a single `SupersedingEventEnabler` using the desired record types. While `CalendaringRulesManager.getSupersedingEventEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `SupersedingEventEnabler`. Providing an empty array tests if a `SupersedingEventEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`supersedingEventEnablerRecordTypes`	array of superseding event enabler types
Return	`boolean`		`true` if `SupersedingEventEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`supersedingEventEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingEventEnablerFormForCreate
Description	Gets the superseding event enabler form for creating new superseding event enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`supersedingEventEnablerRecordTypes`	array of superseding event enabler types
Return	`osid.calendaring.rules.SupersedingEventEnablerForm`		the superseding event enabler form
Errors	NULL_ARGUMENT		`supersedingEventEnablerRecordTypes` 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	createSupersedingEventEnabler
Description	Creates a new `SupersedingEventEnabler`.
Parameters	`osid.calendaring.rules.SupersedingEventEnablerForm`	`supersedingEventEnablerForm`	the form for this `SupersedingEventEnabler`
Return	`osid.calendaring.rules.SupersedingEventEnabler`		the new `SupersedingEventEnabler`
Errors	ILLEGAL_STATE		`supersedingEventEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`supersedingEventEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`supersedingEventEnablerForm` did not originate from `getSupersedingEventFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateSupersedingEventEnablers
Description	Tests if this user can update superseding event enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `SupersedingEventEnabler` 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 `SupersedingEventEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingEventEnablerFormForUpdate
Description	Gets the superseding event enabler form for updating an existing superseding event enabler. A new superseding event enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`supersedingEventEnablerId`	the `Id` of the `SupersedingEventEnabler`
Return	`osid.calendaring.rules.SupersedingEventEnablerForm`		the superseding event enabler form
Errors	NOT_FOUND		`supersedingEventEnablerId` is not found
	NULL_ARGUMENT		`supersedingEventEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateSupersedingEventEnabler
Description	Updates an existing superseding event enabler.
Parameters	`osid.calendaring.rules.SupersedingEventEnablerForm`	`supersedingEventEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`supersedingEventEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`supersedingEventEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`supersedingEventEnablerForm` did not originate from `getSupersedingEventFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteSupersedingEventEnablers
Description	Tests if this user can delete superseding event enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `SupersedingEventEnabler` 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 `SupersedingEventEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteSupersedingEventEnabler
Description	Deletes a `SupersedingEventEnabler`.
Parameters	`osid.id.Id`	`supersedingEventEnablerId`	the `Id` of the `SupersedingEventEnabler` to remove
Errors	NOT_FOUND		`supersedingEventEnablerId` not found
	NULL_ARGUMENT		`supersedingEventEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSupersedingEventEnablerAliases
Description	Tests if this user can manage `Id` aliases for superseding 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`		`false` if `SupersedingEventEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasSupersedingEventEnabler
Description	Adds an `Id` to a `SupersedingEventEnabler` for the purpose of creating compatibility. The primary `Id` of the `SupersedingEventEnabler` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another superseding event enabler. it is reassigned to the given superseding event enabler `Id`.
Parameters	`osid.id.Id`	`supersedingEventEnablerId`	the `Id` of a `SupersedingEventEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`supersedingEventEnablerId` not found
	NULL_ARGUMENT		`supersedingEventEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.