OSID - osid.calendaring.ScheduleSlotAdminSession Service Interface Definition

Interface	osid.calendaring.ScheduleSlotAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.calendaring.batch.ScheduleSlotBatchAdminSession`
Used By	`osid.calendaring.CalendaringManager`
Used By	`osid.calendaring.CalendaringProxyManager`
Description	This session creates, updates, and deletes `Schedule Slots`. 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 `ScheduleSlot`, a `ScheduleSlotForm` is requested using `getScheduleSlotFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `ScheduleSlotForm` 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 `ScheduleSlotForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ScheduleSlotForm` corresponds to an attempted transaction. For updates, `ScheduleSlotForms` are requested to the `ScheduleSlot` `Id` that is to be updated using `getScheduleSlotFormForUpdate()`. Similarly, the `ScheduleSlotForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ScheduleSlotForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Schedule Slots`. To unmap a `ScheduleSlot` from the current `Calendar`, the `ScheduleSlotCalendarAssignmentSession` should be used. These delete operations attempt to remove the `ScheduleSlot` 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	canCreateScheduleSlots
Description	Tests if this user can create `ScheduleSlots`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `ScheduleSlot` 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 `ScheduleSlot` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateScheduleSlotWithRecordTypes
Description	Tests if this user can create a single `ScheduleSlot` using the desired record types. While `CalendaringManager.getScheduleSlotRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `ScheduleSlot`. Providing an empty array tests if a `ScheduleSlot` can be created with no records.
Parameters	`osid.type.Type[]`	`scheduleSlotRecordTypes`	array of schedule slot record types
Return	`boolean`		`true` if `ScheduleSlot` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`scheduleSlotRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleSlotFormForCreate
Description	Gets the schedule slot form for creating new schedule slots. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`scheduleSlotRecordTypes`	array of schedule slot record types
Return	`osid.calendaring.ScheduleSlotForm`		the schedule slot form
Errors	NULL_ARGUMENT		`scheduleSlotRecordTypes` 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	createScheduleSlot
Description	Creates a new `ScheduleSlot`.
Parameters	`osid.calendaring.ScheduleSlotForm`	`scheduleSlotForm`	the form for this `ScheduleSlot`
Return	`osid.calendaring.ScheduleSlot`		the new `ScheduleSlot`
Errors	ILLEGAL_STATE		`scheduleSlotForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`scheduleSlotForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`scheduleSlotForm` did not originate from `getScheduleSlotFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateScheduleSlots
Description	Tests if this user can update `ScheduleSlots`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `ScheduleSlot` 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 slot modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleSlotFormForUpdate
Description	Gets the schedule slot form for updating an existing schedule slot. A new schedule slot form should be requested for each update transaction.
Parameters	`osid.id.Id`	`scheduleSlotId`	the `Id` of the `ScheduleSlot`
Return	`osid.calendaring.ScheduleSlotForm`		the schedule slot form
Errors	NOT_FOUND		`scheduleSlotId` is not found
	NULL_ARGUMENT		`scheduleSlotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateScheduleSlot
Description	Updates an existing schedule slot.
Parameters	`osid.calendaring.ScheduleSlotForm`	`scheduleSlotForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`scheduleSlotForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`scheduleSlotForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`scheduleSlotForm` did not originate from `getScheduleSlotFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteScheduleSlots
Description	Tests if this user can delete `ScheduleSlots`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `ScheduleSlot` 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 `ScheduleSlot` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteScheduleSlot
Description	Deletes the `ScheduleSlot` identified by the given `Id`.
Parameters	`osid.id.Id`	`scheduleSlotId`	the `Id` of the `ScheduleSlot` to delete
Errors	NOT_FOUND		a `ScheduleSlot` was not found identified by the given `Id`
	NULL_ARGUMENT		`scheduleSlotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageScheduleSlotAliases
Description	Tests if this user can manage `Id` aliases for `ScheduleSlots`. 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 `ScheduleSlot` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasScheduleSlot
Description	Adds an `Id` to a `ScheduleSlot` for the purpose of creating compatibility. The primary `Id` of the `ScheduleSlot` 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 slot, it is reassigned to the given schedule slot `Id`.
Parameters	`osid.id.Id`	`scheduleSlotId`	the `Id` of a `ScheduleSlot`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`scheduleSlotId` not found
	NULL_ARGUMENT		`scheduleSlotId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.