OSID - osid.calendaring.EventAdminSession Service Interface Definition

Interface	osid.calendaring.EventAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.calendaring.batch.EventBatchAdminSession`
Used By	`osid.calendaring.CalendaringManager`
Used By	`osid.calendaring.CalendaringProxyManager`
Description	This session creates, updates, and deletes `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 an `Event`, an `EventForm` is requested using `getEventFormForCreate()` specifying the desired and record `Types` or none if no record `Types` are needed. The returned `EventForm` 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 `EventForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `EventForm` corresponds to an attempted transaction. For updates, `EventForms` are requested to the `Event` `Id` that is to be updated using `getEventFormForUpdate()`. Similarly, the `EventForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `EventForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Events`. To unmap an `Event` from the current `Calendar`, the `EventCalendarAssignmentSession` should be used. These delete operations attempt to remove the `Event` 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	canCreateEvents
Description	Tests if this user can create `Events`. 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	canCreateEventWithRecordTypes
Description	Tests if this user can create a single `Event` using the desired record types. While `CalendaringManager.getEventRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Event`. Providing an empty array tests if an `Event` can be created with no records.
Parameters	`osid.type.Type[]`	`eventRecordTypes`	array of event record types
Return	`boolean`		`true` if `Event` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`eventRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEventFormForCreate
Description	Gets the event form for creating new events. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`eventRecordTypes`	array of event record types
Return	`osid.calendaring.EventForm`		the event form
Errors	NULL_ARGUMENT		`eventRecordTypes` 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	createEvent
Description	Creates a new `Event`.
Parameters	`osid.calendaring.EventForm`	`eventForm`	the form for this `Event`
Return	`osid.calendaring.Event`		the new `Event`
Errors	ILLEGAL_STATE		`eventForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`eventForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`eventForm` did not originate from `getEventFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateEvents
Description	Tests if this user can update `Events`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Event` 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 event modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEventFormForUpdate
Description	Gets the event form for updating an existing event. A new event form should be requested for each update transaction.
Parameters	`osid.id.Id`	`eventId`	the `Id` of the `Event`
Return	`osid.calendaring.EventForm`		the event form
Errors	NOT_FOUND		`eventId` is not found
	NULL_ARGUMENT		`eventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateEvent
Description	Updates an existing event.
Parameters	`osid.calendaring.EventForm`	`eventForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`eventForm` already used in an update transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`eventForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`eventForm` did not originate from `getEventFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteEvents
Description	Tests if this user can delete `Events`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Event` 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 `Event` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteEvent
Description	Deletes the `Event` identified by the given `Id`.
Parameters	`osid.id.Id`	`eventId`	the `Id` of the `Event` to delete
Errors	NOT_FOUND		an `Event` was not found identified by the given `Id`
	NULL_ARGUMENT		`eventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageEventAliases
Description	Tests if this user can manage `Id` aliases for `Events`. 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 `Event` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasEvent
Description	Adds an `Id` to an `Event` for the purpose of creating compatibility. The primary `Id` of the `Event` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another event, it is reassigned to the given event `Id`.
Parameters	`osid.id.Id`	`eventId`	the `Id` of an `Event`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`eventId` not found
	NULL_ARGUMENT		`eventId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.