OSID - osid.calendaring.ScheduleAdminSession Service Interface Definition

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