OSID - osid.calendaring.cycle.CyclicEventAdminSession Service Interface Definition

Interface	osid.calendaring.cycle.CyclicEventAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.calendaring.cycle.batch.CyclicEventBatchAdminSession`
Used By	`osid.calendaring.cycle.CalendaringCycleManager`
Used By	`osid.calendaring.cycle.CalendaringCycleProxyManager`
Description	This session creates, updates, and deletes `CyclicEvents`. 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 `CyclicEvent`, a `CyclicEventForm` is requested using `getCyclicEventFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `CycllicEventForm` 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 `CyclicEventForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `CyclicEventForm` corresponds to an attempted transaction. For updates, `CycliccEventForms` are requested to the `CyclicEvent` `Id` that is to be updated using `getCyclicEventFormForUpdate()`. Similarly, the `CyclicEventForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `CyclicEventForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Cyclic Events`. To unmap a `CyclicEvent` from the current `Calendar`, the `CyclicEventCalendarAssignmentSession` should be used. These delete operations attempt to remove the `CyclicEvent` 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	canCreateCyclicEvents
Description	Tests if this user can create `CyclicEvents`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `CyclicEvent` 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 `CyclicEvent` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCyclicEventWithRecordTypes
Description	Tests if this user can create a single `CyclicEvent` using the desired record types. While `CalendaringCycleManager.getCyclicEventRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `CyclicEvent`. Providing an empty array tests if a `CyclicEvent` can be created with no records.
Parameters	`osid.type.Type[]`	`cyclicEventRecordTypes`	array of cyclic event record types
Return	`boolean`		`true` if `CyclicEvent` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`cyclicEventRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicEventFormForCreate
Description	Gets the cyclic event form for creating new cyclic events. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`cyclicEventRecordTypes`	array of cyclic event record types
Return	`osid.calendaring.cycle.CyclicEventForm`		the cyclic event form
Errors	NULL_ARGUMENT		`cyclicEventRecordTypes` 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	createCyclicEvent
Description	Creates a new `CyclicEvent`.
Parameters	`osid.calendaring.cycle.CyclicEventForm`	`cyclicEventForm`	the form for this `CyclicEvent`
Return	`osid.calendaring.cycle.CyclicEvent`		the new `CyclicEvent`
Errors	ILLEGAL_STATE		`cyclicEventForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`cyclicEventForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`cyclicEventForm` did not originate from `getCyclicEventFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateCyclicEvents
Description	Tests if this user can update `CyclicEvents`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `CyclicEvent` 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 cyclic event modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCyclicEventFormForUpdate
Description	Gets the cyclic event form for updating an existing cyclic event. A new event form should be requested for each update transaction.
Parameters	`osid.id.Id`	`cyclicEventId`	the `Id` of the `CyclicEvent`
Return	`osid.calendaring.cycle.CyclicEventForm`		the cyclic event form
Errors	NOT_FOUND		`cyclicEventId` is not found
	NULL_ARGUMENT		`cyclicEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateCyclicEvent
Description	Updates an existing cyclic event.
Parameters	`osid.calendaring.cycle.CyclicEventForm`	`cyclicEventForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`cyclicEventForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`cyclicEventForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`cyclicEventForm` did not originate from `getCyclicEventFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteCyclicEvents
Description	Tests if this user can delete `CyclicEvents`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `CyclicEvent` 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 `CyclicEvent` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCyclicEvent
Description	Deletes the `CyclicEvent` identified by the given `Id`.
Parameters	`osid.id.Id`	`cyclicEventId`	the `Id` of the `CyclicEvent` to delete
Errors	NOT_FOUND		a `CyclicEvent` was not found identified by the given `Id`
	NULL_ARGUMENT		`cyclicEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCyclicEventAliases
Description	Tests if this user can manage `Id` aliases for `CyclicEvents`. 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 `CyclicEvent` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCyclicEvent
Description	Adds an `Id` to a `CyclicEvent` for the purpose of creating compatibility. The primary `Id` of the `CyclicEvent` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another cyclic event, it is reassigned to the given cyclic event `Id`.
Parameters	`osid.id.Id`	`cyclicEventId`	the `Id` of a `CyclicEvent`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`cyclicEventId` not found
	NULL_ARGUMENT		`cyclicEventId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.