OSID - osid.calendaring.OffsetEventAdminSession Service Interface Definition

Interface	osid.calendaring.OffsetEventAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.calendaring.batch.OffsetEventBatchAdminSession`
Used By	`osid.calendaring.CalendaringManager`
Used By	`osid.calendaring.CalendaringProxyManager`
Description	This session creates, updates, and deletes `Offset 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 `OffsetEvent`, an `OffsetEventForm` is requested using `getOffsetEventFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `OffsetEventForm` 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 `OffsetEventForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `OffsetEventForm` corresponds to an attempted transaction. For updates, `OffsetEventForms` are requested to the `OffsetEvent` `Id` that is to be updated using `getOffsetEventFormForUpdate()`. Similarly, the `OffsetventForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `OffsetEventForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Offset Events`. To unmap an `OffsetEvent` from the current `Calendar`, the `OffstEventCalendarAssignmentSession` should be used. These delete operations attempt to remove the `OffsetEvent` 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	canCreateOffsetEvents
Description	Tests if this user can create `OffsetEvents`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `OffsetEvent` 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 `OffsetEvent` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateOffsetEventWithRecordTypes
Description	Tests if this user can create a single `OffsetEvent` using the desired record types. While `CalendaringManager.getOffsetEventRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `OffsetEvent`. Providing an empty array tests if an `OffsetEvent` can be created with no records.
Parameters	`osid.type.Type[]`	`offsetEventRecordTypes`	array of offset event record types
Return	`boolean`		`true` if `OffsetEvent` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`offsetEventRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getOffsetEventFormForCreate
Description	Gets the offset event form for creating new offset events. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`offsetEventRecordTypes`	array of offset event record types
Return	`osid.calendaring.OffsetEventForm`		the offset event form
Errors	NULL_ARGUMENT		`offsetEventRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested recod types
Compliance	`mandatory`		This method must be implemented.
Method	createOffsetEvent
Description	Creates a new `OffsetEvent`.
Parameters	`osid.calendaring.OffsetEventForm`	`offsetEventForm`	the form for this `OffsetEvent`
Return	`osid.calendaring.OffsetEvent`		the new `OffsetEvent`
Errors	ILLEGAL_STATE		`offsetEventForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`offsetEventForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`offsetEventForm` did not originate from `getOffsetEventFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateOffsetEvents
Description	Tests if this user can update `OffsetEvents`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `OffsetEvent` 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 offset event modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOffsetEventFormForUpdate
Description	Gets the offset event form for updating an existing offset event. A new offset event form should be requested for each update transaction.
Parameters	`osid.id.Id`	`offsetEventId`	the `Id` of the `OffsetEvent`
Return	`osid.calendaring.OffsetEventForm`		the offset event form
Errors	NOT_FOUND		`offsetEventId` is not found
	NULL_ARGUMENT		`offsetEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateOffsetEvent
Description	Updates an existing offset event.
Parameters	`osid.calendaring.OffsetEventForm`	`offsetEventForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`offsetEventForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`offsetEventForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`offsetEventForm` did not originate from `getOffsetEventFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteOffsetEvents
Description	Tests if this user can delete `OffsetEvents`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `OffsetEvent` 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 `OffsetEvent` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteOffsetEvent
Description	Deletes the `OffsetEvent` identified by the given `Id`.
Parameters	`osid.id.Id`	`offsetEventId`	the `Id` of the `OffsetEvent` to delete
Errors	NOT_FOUND		an `OffsetEvent` was not found identified by the given `Id`
	NULL_ARGUMENT		`offsetEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageOffsetEventAliases
Description	Tests if this user can manage `Id` aliases for `OffsetEvents`. 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 `OffsetEvent` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasOffsetEvent
Description	Adds an `Id` to an `OffsetEvent` for the purpose of creating compatibility. The primary `Id` of the `OffsetEvent` 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, it is reassigned to the given offset event `Id`.
Parameters	`osid.id.Id`	`offsetEventId`	the `Id` of an `OffsetEvent`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`offsetEventId` not found
	NULL_ARGUMENT		`offsetEventId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.