OSID - osid.calendaring.SupersedingEventAdminSession Service Interface Definition

Interface	osid.calendaring.SupersedingEventAdminSession
Implements	`osid.OsidSession`
Used By	`osid.calendaring.CalendaringManager`
Used By	`osid.calendaring.CalendaringProxyManager`
Description	This session creates, updates, and deletes `Superseding Events`. The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `SupersedingEvent`, a `SupersedingEventForm` is requested using `getSupersedingEventFormForCreate()` specifying the desired relationship peers and record `Types` or none if no record `Types` are needed. The returned `SupersedingEventForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `SupersedingEventForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `SupersedingEventForm` corresponds to an attempted transaction. For updates, `SupersedingEventForms` are requested to the `SupersedingEvent` `Id` that is to be updated using `getSupersedingEventFormForUpdate()`. Similarly, the `SupersedingEventForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `SupersedingEventForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Superseding Events`. To unmap a `SupersedingEvent` from the current `Calendar`, the `SupersedingEventCalendarAssignmentSession` should be used. These delete operations attempt to remove the `SupersedingEvent` itself thus removing it from all known `Calendar` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
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` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateSupersedingEvents
Description	Tests if this user can create `SupersedingEvents`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an Event 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 `Event` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateSupersedingEventWithRecordTypes
Description	Tests if this user can create a single `SupersedingEvent` using the desired record types. While `CalendaringManager.getSupersedingEventRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `SupersedingEvent`. Providing an empty array tests if a `RecurringEvent` can be created with no records.
Parameters	`osid.type.Type[]`	`supersdeingEventRecordTypes`	array of superseding evnt record types
Return	`boolean`		`true` if `SupersedingEvent` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`supersedingEventRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingEventFormForCreate
Description	Gets the superseding event form for creating new events. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`supersededEventId`	the `Id` of the superseded event
	`osid.id.Id`	`supersedingEventId`	the `Id` of the superseding event
	`osid.type.Type[]`	`supersdeingEventRecordTypes`	array of superseding evnt record types
Return	`osid.calendaring.SupersedingEventForm`		the superseding event form
Errors	NOT_FOUND		`supersededEventId` or `supersedingEventId` not found
	NULL_ARGUMENT		`supersededEventId, supersedingEventId`, or `supersdeingEventRecordTypes` 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	createSupersedingEvent
Description	Creates a new `SupersedingEvent`.
Parameters	`osid.calendaring.SupersedingEventForm`	`supersedingEventForm`	the form for this `SupersedingEvent`
Return	`osid.calendaring.SupersedingEvent`		the new `SupersedingEvent`
Errors	ILLEGAL_STATE		`supersdeingEventForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`supersdeingEventForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`supersedingEventForm` did not originate from `getSupersedingEventFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateSupersedingEvents
Description	Tests if this user can update `SupersedingEvents`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `SupersedingEvent` 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 superseding event modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingEventFormForUpdate
Description	Gets the superseding event form for updating an existing superseding event. A new superseding event form should be requested for each update transaction.
Parameters	`osid.id.Id`	`supersedingEventId`	the `Id` of the `SupersedingEvent`
Return	`osid.calendaring.SupersedingEventForm`		the superseding event form
Errors	NOT_FOUND		`supersedingEventId` is not found
	NULL_ARGUMENT		`supersedingEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateSupersedingEvent
Description	Updates an existing superseding event.
Parameters	`osid.calendaring.SupersedingEventForm`	`supersedingEventForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`supersdeingEventForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`supersedingEventForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`supersedingEventForm` did not originate from `getSupersedingEventFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteSupersedingEvents
Description	Tests if this user can delete `SupersedingEvents`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `SupersedingEvent` 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 `SupersedingEvent` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteSupersedingEvent
Description	Deletes the `SupersedingEvent` identified by the given `Id`.
Parameters	`osid.id.Id`	`supersedingEventId`	the `Id` of the `SupersedingEvent` to delete
Errors	NOT_FOUND		a `SupersedingEvent` was not found identified by the given `Id`
	NULL_ARGUMENT		`supersedingEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSupersedingEventAliases
Description	Tests if this user can manage `Id` aliases for `SupersedingEvents`. 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 `SupersedingEvent` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasSupersedingEvent
Description	Adds an `Id` to a `SupersedingEvent` for the purpose of creating compatibility. The primary `Id` of the `SupersedingEvent` 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, it is reassigned to the given superseding event `Id`.
Parameters	`osid.id.Id`	`supersedingEventId`	the `Id` of a `SupersedingEvent`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`supersedingEventId` not found
	NULL_ARGUMENT		`supersedingEventId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.