OSID - osid.calendaring.RecurringEventAdminSession Service Interface Definition

Interface	osid.calendaring.RecurringEventAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.calendaring.batch.RecurringEventBatchAdminSession`
Used By	`osid.calendaring.CalendaringManager`
Used By	`osid.calendaring.CalendaringProxyManager`
Description	This session creates, updates, and deletes `RecurringEvents`. 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 `RecurringEvent`, a `RecurringEventForm` is requested using `getRecurringEventFormForCreate()` specifying the desired relationship peers and record `Types` or none if no record `Types` are needed. The returned `RecurringEventForm` 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 `RecurringEventForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `RecurringEventForm` corresponds to an attempted transaction. For updates, `RecurringEventForms` are requested to the `RecurringEvent` `Id` that is to be updated using `getRecurringEventFormForUpdate()`. Similarly, the `RecurringEventForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `RecurringEventForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Recurring Events` . To unmap a `RecurringEvent` from the current `Calendar`, the `RecurringEventCalendarAssignmentSession` 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	canCreateRecurringEvents
Description	Tests if this user can create `RecurringEvents`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `RecurringEvent` 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 `RecurringEvent` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRecurringEventWithRecordTypes
Description	Tests if this user can create a single `RecurringEvent` using the desired record types. While `CalendaringManager.getRecurringEventRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `RecurringEvent`. Providing an empty array tests if a `RecurringEvent` can be created with no records.
Parameters	`osid.type.Type[]`	`recurringEventRecordTypes`	array of recurring event types
Return	`boolean`		`true` if `RecurringEvent` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`recurringEventRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventFormForCreate
Description	Gets the recurring event form for creating new recurring events. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`recurringEventRecordTypes`	array of recurring event types
Return	`osid.calendaring.RecurringEventForm`		the recurring event form
Errors	NULL_ARGUMENT		`recurringEventRecordTypes` 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	createRecurringEvent
Description	Creates a new `RecurringEvent`.
Parameters	`osid.calendaring.RecurringEventForm`	`recurringEventForm`	the form for this `RecurringEvent`
Return	`osid.calendaring.RecurringEvent`		the new `RecurringEvent`
Errors	ILLEGAL_STATE		`recurringEventForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`recurringEventForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`recurringEventForm` did not originate in a create transaction
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateRecurringEvents
Description	Tests if this user can update `RecurringEvents`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `RecurringEvent` 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 recurring event modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventFormForUpdate
Description	Gets the recurring event form for updating an existing recurring event. A new recurring event form should be requested for each update transaction.
Parameters	`osid.id.Id`	`recurringEventId`	the `Id` of the `RecurringEvent`
Return	`osid.calendaring.RecurringEventForm`		the recurring event form
Errors	NOT_FOUND		`recurringEventId` is not found
	NULL_ARGUMENT		`recurringEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateRecurringEvent
Description	Updates an existing recurring event.
Parameters	`osid.calendaring.RecurringEventForm`	`recurringEventForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`recurringEventForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`recurringEventForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`recurringEventForm` did not originate in an update transaction
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteRecurringEvents
Description	Tests if this user can delete `RecurringEvents`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `RecurringEvent` 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 `RecurringEvent` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteRecurringEvent
Description	Deletes the `RecurringEvent` identified by the given `Id`.
Parameters	`osid.id.Id`	`recurringEventId`	the `Id` of the `RecurringEvent` to delete
Errors	NOT_FOUND		a `RecurringEvent` was not found identified by the given `Id`
	NULL_ARGUMENT		`recurringEventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageRecurringEventAliases
Description	Tests if this user can manage `Id` aliases for `RecurringEvents`. 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 `RecurringEvent` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasRecurringEvent
Description	Adds an `Id` to a `RecurringEvent` for the purpose of creating compatibility. The primary `Id` of the `RecurringEvent` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another recurring event, it is reassigned to the given recurring event `Id`.
Parameters	`osid.id.Id`	`recurringEventId`	the `Id` of a `RecurringEvent`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`recurringEventId` not found
	NULL_ARGUMENT		`recurringEventId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canScheduleRecurringEvents
Description	Tests if this user can schedule recurring events. A return of true does not guarantee successful authorization. A return of false indicates that it is known recurring event methods in this session 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 recurring event scheduling is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	addSchedule
Description	Adds a schedule to the given recurring event.
Parameters	`osid.id.Id`	`recurringEventId`	a recurring event `Id`
Parameters	`osid.id.Id`	`scheduleId`	a schedule `Id`
Return	`osid.id.Id`		the `Id` of the schedule
Errors	ALREADY_EXISTS		schedule is already part of recurring event
	NOT_FOUND		`recurringEventId` or `scheduleId` is not found
	NULL_ARGUMENT		`recurringEventId` or `scheduleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeSchedule
Description	Removes a schedule from a given recurring event.
Parameters	`osid.id.Id`	`recurringEventId`	a recurring event `Id`
Parameters	`osid.id.Id`	`scheduleId`	the schedule `Id`
Errors	NOT_FOUND		schedule not part of recurring event
	NULL_ARGUMENT		`recurringEventId` or `scheduleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addSpecificDate
Description	Adds a specific date to the given recurring event.
Parameters	`osid.id.Id`	`recurringEventId`	a recurring event `Id`
	`osid.calendaring.DateTime`	`date`	a date
	`osid.locale.DisplayText`	`locationDescription`	location description
Errors	NOT_FOUND		`recurringEventId` is not found
	NULL_ARGUMENT		`recurringEventId, date`, or `locationDescription` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addSpecificDateWithLocation
Description	Adds a specific date to the given recurring event.
Parameters	`osid.id.Id`	`recurringEventId`	a recurring event `Id`
	`osid.calendaring.DateTime`	`date`	a date
	`osid.id.Id`	`locationId`	a location
Errors	NOT_FOUND		`recurringEventId` or `locationId` is not found
	NULL_ARGUMENT		`recurringEventId, date`, or `locationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	clearSpecificDates
Description	Clears any specific dates between the given dates inclusive.
Parameters	`osid.id.Id`	`recurringEventId`	a recurring event `Id`
	`osid.calendaring.DateTime`	`from`	start date inclusive
	`osid.calendaring.DateTime`	`to`	end date inclusive
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NOT_FOUND		`recurringEventId` is not found
	NULL_ARGUMENT		`recurringEventId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addEvent
Description	Adds another event as part of this recurring event.
Parameters	`osid.id.Id`	`recurringEventId`	a recurring event `Id`
Parameters	`osid.id.Id`	`eventId`	an event `Id`
Errors	NOT_FOUND		`recurringEventId` or `eventId` is not found
	NULL_ARGUMENT		`recurringEventId` or `eventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	removeEvent
Description	Removes an event as part of this recurring event.
Parameters	`osid.id.Id`	`recurringEventId`	a recurring event `Id`
Parameters	`osid.id.Id`	`eventId`	an event `Id`
Errors	NOT_FOUND		`recurringEventId` or `eventId` is not found or `eventId` not part of `recurringEventId`
	NULL_ARGUMENT		`recurringEventId` or `eventId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	addBlackout
Description	Adds a blackout to the given recurring event that blocks events in the series.
Parameters	`osid.id.Id`	`recurringEventId`	a recurring event `Id`
	`osid.calendaring.DateTime`	`from`	start date inclusive
	`osid.calendaring.DateTime`	`to`	end date inclusive
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NOT_FOUND		`recurringEventId` is not found
	NULL_ARGUMENT		`recurringEventId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	clearBlackout
Description	Clears any blackouts between the given dates inclusive.
Parameters	`osid.id.Id`	`recurringEventId`	a recurring event `Id`
	`osid.calendaring.DateTime`	`from`	start date inclusive
	`osid.calendaring.DateTime`	`to`	end date inclusive
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NOT_FOUND		`recurringEventId` is not found
	NULL_ARGUMENT		`recurringEventId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.