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

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