OSID - osid.personnel.AppointmentRealmAssignmentSession Service Interface Definition

Interface	osid.personnel.AppointmentRealmAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.personnel.PersonnelManager`
Used By	`osid.personnel.PersonnelProxyManager`
Description	This session provides methods to re-assign `Appointments` to `Bilings`. An `Appointment` may map to multiple `Realms` and removing the last reference to an `Appointment` is the equivalent of deleting it. Each `Realm` may have its own authorizations governing who is allowed to operate on it. Adding a reference of an `Appointment` to another `Realm` is not a copy operation (eg: does not change its `Id`).
Method	canAssignAppointments
Description	Tests if this user can alter appointment/realm mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignAppointmentsToRealm
Description	Tests if this user can alter appointment/realm mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.
Parameters	`osid.id.Id`	`realmId`	the `Id` of the `Realm`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`realmId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableRealmIds
Description	Gets a list of realms including and under the given realm node in which any appointment can be assigned.
Parameters	`osid.id.Id`	`realmId`	the `Id` of the `Realm`
Return	`osid.id.IdList`		list of assignable realm `Ids`
Errors	NULL_ARGUMENT		`realmId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignableRealmIdsForAppointment
Description	Gets a list of realms including and under the given realm node in which a specific appointment can be assigned.
Parameters	`osid.id.Id`	`realmId`	the `Id` of the `Realm`
Parameters	`osid.id.Id`	`appointmentId`	the `Id` of the `Appointment`
Return	`osid.id.IdList`		list of assignable realm `Ids`
Errors	NULL_ARGUMENT		`realmId` or `appointmentId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignAppointmentToRealm
Description	Adds an existing `Appointment` to a `Realm`.
Parameters	`osid.id.Id`	`appointmentId`	the `Id` of the `Appointment`
Parameters	`osid.id.Id`	`realmId`	the `Id` of the `Realm`
Errors	ALREADY_EXISTS		`appointmentId` already assigned to `realmId`
	NOT_FOUND		`appointmentId` or `realmId` not found
	NULL_ARGUMENT		`appointmentId` or `realmId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignAppointmentFromRealm
Description	Removes an `Appointment` from a `Realm`.
Parameters	`osid.id.Id`	`appointmentId`	the `Id` of the `Appointment`
Parameters	`osid.id.Id`	`realmId`	the `Id` of the `Realm`
Errors	NOT_FOUND		`appointmentId` or `realmId` not found or `appointmentId` not mapped to `realmId`
	NULL_ARGUMENT		`appointmentId` or `realmId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignAppointmentToRealm
Description	Moves an `Appointment` from one `Realm` to another. Mappings to other `Realms` are unaffected.
Parameters	`osid.id.Id`	`appointmentId`	the `Id` of the `Appointment`
	`osid.id.Id`	`fromRealmId`	the `Id` of the current `Realm`
	`osid.id.Id`	`toRealmId`	the `Id` of the destination `Realm`
Errors	ALREADY_EXISTS		`appointmentId` already assigned to `toRealmId`
	NOT_FOUND		`appointmentId, fromRealmId`, or `toRealmId` not found or `appointmentId` not mapped to `fromRealmId`
	NULL_ARGUMENT		`appointmentId, fromRealmId`, or `toRealmId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.