OSID - osid.personnel.AppointmentAdminSession Service Interface Definition

Interface	osid.personnel.AppointmentAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Appointments.` 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 `Appointment,` an `AppointmentForm` is requested using `getAppointmentFormForCreate()` specifying the desired relationship peers and record `Types` or none if no record `Types` are needed. The returned `AppointmentForm` 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 `AppointmentForm` is submitted to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `AppointmentForm` corresponds to an attempted transaction. For updates, `AppointmentForms` are requested to the `Appointment` `Id` that is to be updated using `getAppointmentFormForUpdate().` Similarly, the `AppointmentForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `AppointmentForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Appointments.` To unmap an `Appointment` from the current `Realm,` the `AppointmentRealmAssignmentSession` should be used. These delete operations attempt to remove the `Appointment` itself thus removing it from all known `Realm` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getRealmId
Description	Gets the `Realm` `Id` associated with this session.
Return	`osid.id.Id`		the `Realm Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getRealm
Description	Gets the `Realm` associated with this session.
Return	`osid.personnel.Realm`		the realm
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAppointments
Description	Tests if this user can create appointments. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Appointment` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `Appointment` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAppointmentWithRecordTypes
Description	Tests if this user can create a single `Appointment` using the desired record types. While `PersonnelManager.getAppointmentRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Appointment.` Providing an empty array tests if an `Appointment` can be created with no records.
Parameters	`osid.type.Type[]`	`appointmentRecordTypes`	array of appointment record types
Return	`boolean`		`true` if `Appointment` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`appointmentRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAppointmentFormForCreate
Description	Gets the appointment form for creating new appointments. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`personId`	the person `Id`
	`osid.id.Id`	`positionId`	the position `Id`
	`osid.type.Type[]`	`appointmentRecordTypes`	array of appointment record types to be included in the create operation or an empty list if none
Return	`osid.personnel.AppointmentForm`		the appointment form
Errors	NOT_FOUND		`personId` or `positionId` is not found
	NULL_ARGUMENT		`personId, positionId,` or `appointmentRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		cannot get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createAppointment
Description	Creates a new `Appointment.`
Parameters	`osid.personnel.AppointmentForm`	`appointmentForm`	the form for this `Appointment`
Return	`osid.personnel.Appointment`		the new `Appointment`
Errors	ILLEGAL_STATE		`appointmentForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`appointmentForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`appointmentForm` did not originate from `getAppointmentFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAppointments
Description	Tests if this user can update appointments. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Appointment` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `Appointment` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAppointmentFormForUpdate
Description	Gets the appointment form for updating an existing appointment. A new appointment form should be requested for each update transaction.
Parameters	`osid.id.Id`	`appointmentId`	the `Id` of the `Appointment`
Return	`osid.personnel.AppointmentForm`		the appointment form
Errors	NOT_FOUND		`appointmentId` is not found
	NULL_ARGUMENT		`appointmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateAppointment
Description	Updates an existing appointment.
Parameters	`osid.personnel.AppointmentForm`	`appointmentForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`appointmentForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`appointmentForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`appointmentForm` did not originate from `getAppointmentFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAppointments
Description	Tests if this user can delete appointments. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Appointment` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `Appointment` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteAppointment
Description	Deletes an `Appointment.`
Parameters	`osid.id.Id`	`appointmentId`	the `Id` of the `Appointment` to remove
Errors	NOT_FOUND		`appointmentId` not found
	NULL_ARGUMENT		`appointmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageAppointmentAliases
Description	Tests if this user can manage `Id` aliases for `Appointments.` 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 `Appointment` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasAppointment
Description	Adds an `Id` to an `Appointment` for the purpose of creating compatibility. The primary `Id` of the `Appointment` is determined by the provider. The new `Id` is an alias to the primary `Id.` If the alias is a pointer to another appointment, it is reassigned to the given appointment `Id.`
Parameters	`osid.id.Id`	`appointmentId`	the `Id` of an `Appointment`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`appointmentId` not found
	NULL_ARGUMENT		`appointmentId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.