OSID - osid.profile.ProfileItemAdminSession Service Interface Definition

Interface	osid.profile.ProfileItemAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `ProfileItems.` 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 `ProfileItem,` a `ProfileItemForm` is requested using `getProfileItemFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `ProfileItemForm` 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 `ProfileItemForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ProfileItemForm` corresponds to an attempted transaction. For updates, `ProfileItemForms` are requested to the `ProfileItem` `Id` that is to be updated using `getProfileItemFormForUpdate().` Similarly, the `ProfileItemForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ProfileItemForm` can only be used once for a successful update and cannot be reused. The delete operations delete `ProfileItems.` To unmap a `ProfileItem` from the current `Profile` the `ProfileItemProfileAssignmentSession` should be used. These delete operations attempt to remove the `ProfileItem` itself thus removing it from all known `Profile` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getProfileId
Description	Gets the `Profile` `Id` associated with this session.
Return	`osid.id.Id`		the `Profile Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getProfile
Description	Gets the `Profile` associated with this session.
Return	`osid.profile.Profile`		the `Profile` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateProfileItems
Description	Tests if this user can create `ProfileItems.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `ProfileItem` 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 `ProfileItem` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateProfileItemWithRecordTypes
Description	Tests if this user can create a single `ProfileItem` using the desired record types. While `ProfileManager.getProfileItemRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `ProfileItem.` Providing an empty array tests if a `ProfileItem` can be created with no records.
Parameters	`osid.type.Type[]`	`profileItemRecordTypes`	array of profile item record types
Return	`boolean`		`true` if `ProfileItem` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`profileItemRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProfileItemFormForCreate
Description	Gets the profile item form for creating new profile items. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`profileItemRecordTypes`	array of profile item record types
Return	`osid.profile.ProfileItemForm`		the profile item form
Errors	NULL_ARGUMENT		`profileItemRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form with requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createProfileItem
Description	Creates a new `ProfileItem.`
Parameters	`osid.profile.ProfileItemForm`	`profileItemForm`	the form for this `ProfileItem`
Return	`osid.profile.ProfileItem`		the new `ProfileItem`
Errors	ILLEGAL_STATE		`profileItemForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`profileItemForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`profileItemForm` did not originate from `getProfileItemFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateProfileItems
Description	Tests if this user can update `ProfileItems.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `ProfileItem` 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 profile item modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProfileItemFormForUpdate
Description	Gets the profile item form for updating an existing profile item. A new profile item form should be requested for each update transaction.
Parameters	`osid.id.Id`	`profileItemId`	the `Id` of the `ProfileItem`
Return	`osid.profile.ProfileItemForm`		the profile item form
Errors	NOT_FOUND		`profileItemId` is not found
	NULL_ARGUMENT		`profileItemId` is `null`
	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	updateProfileItem
Description	Updates an existing profile item.
Parameters	`osid.profile.ProfileItemForm`	`profileItemForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`profileItemForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`profileItemForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`profileItemForm` did not originate from `getProfileItemFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteProfileItems
Description	Tests if this user can delete `ProfileItems.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `ProfileItem` 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 `ProfileItem` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteProfileItem
Description	Deletes the `ProfileItem` identified by the given `Id.`
Parameters	`osid.id.Id`	`profileItemId`	the `Id` of the `ProfileItem` to delete
Errors	NOT_FOUND		a `ProfileItem` was not found identified by the given `Id`
	NULL_ARGUMENT		`profileItemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageProfileItemAliases
Description	Tests if this user can manage `Id` aliases for `ProfileItems.` 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 `ProfileItem` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasProfileItem
Description	Adds an `Id` to a `ProfileItem` for the purpose of creating compatibility. The primary `Id` of the `ProfileItem` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another profile item it is reassigned to the given profile item `Id.`
Parameters	`osid.id.Id`	`profileItemId`	the `Id` of a `ProfileItem`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`profileItemId` not found
	NULL_ARGUMENT		`profileItemId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.