OSID - osid.personnel.PersonAdminSession Service Interface Definition

Interface	osid.personnel.PersonAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Persons.` 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 `Person,` a `PersonForm` is requested using `getPersonFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `PersonForm` 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 `PersonForm` is submitted to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `PersonForm` corresponds to an attempted transaction. For updates, `PersonForms` are requested to the `Person` `Id` that is to be updated using `getPersonFormForUpdate().` Similarly, the `PersonForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `PersonForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Persons.` To unmap a `Person` from the current `Realm,` the `PersonRealmAssignmentSession` should be used. These delete operations attempt to remove the `Person` 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	canCreatePersons
Description	Tests if this user can create persons. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Person` 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 `Person` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreatePersonWithRecordTypes
Description	Tests if this user can create a single `Person` using the desired record types. While `PersonnelManager.getPersonRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Person.` Providing an empty array tests if a `Person` can be created with no records.
Parameters	`osid.type.Type[]`	`personRecordTypes`	array of person record types
Return	`boolean`		`true` if `Person` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`personRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPersonFormForCreate
Description	Gets the person form for creating new persons. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`personRecordTypes`	array of person record types to be included in the create operation or an empty list if none
Return	`osid.personnel.PersonForm`		the person form
Errors	NULL_ARGUMENT		`personRecordTypes` 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	createPerson
Description	Creates a new `Person.`
Parameters	`osid.personnel.PersonForm`	`personForm`	the form for this `Person`
Return	`osid.personnel.Person`		the new `Person`
Errors	ILLEGAL_STATE		`personForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`personForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`personForm` did not originate from `getPersonFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdatePersons
Description	Tests if this user can update persons. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Person` 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 `Person` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPersonFormForUpdate
Description	Gets the person form for updating an existing person. A new person form should be requested for each update transaction.
Parameters	`osid.id.Id`	`personId`	the `Id` of the `Person`
Return	`osid.personnel.PersonForm`		the person form
Errors	NOT_FOUND		`personId` is not found
	NULL_ARGUMENT		`personId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updatePerson
Description	Updates an existing person.
Parameters	`osid.personnel.PersonForm`	`personForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`personForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`personForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`personForm` did not originate from `getPersonFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeletePersons
Description	Tests if this user can delete persons. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Person` 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 `Person` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deletePerson
Description	Deletes a `Person.`
Parameters	`osid.id.Id`	`personId`	the `Id` of the `Person` to remove
Errors	NOT_FOUND		`personId` not found
	NULL_ARGUMENT		`personId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManagePersonAliases
Description	Tests if this user can manage `Id` aliases for `Persons.` 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 `Person` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasPerson
Description	Adds an `Id` to a `Person` for the purpose of creating compatibility. The primary `Id` of the `Person` is determined by the provider. The new `Id` is an alias to the primary `Id.` If the alias is a pointer to another person, it is reassigned to the given person `Id.`
Parameters	`osid.id.Id`	`personId`	the `Id` of a `Person`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`personId` not found
	NULL_ARGUMENT		`personId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.