OSID - osid.profile.ProfileAdminSession Service Interface Definition

Interface	osid.profile.ProfileAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Profiles.` 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 `Profile,` a `ProfileForm` is requested using `getProfileFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `ProfileForm` 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 `ProfileForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ProfileForm` corresponds to an attempted transaction. For updates, `ProfileForms` are requested to the `Profile` `Id` that is to be updated using `getProfileFormForUpdate().` Similarly, the `Profile` has metadata about the data that can be updated and it can perform validation before submitting the update. The `Profile` can only be used once for a successful update and cannot be reused. The delete operations delete `Profiles.` This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	canCreateProfiles
Description	Tests if this user can create `Profiles.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Profile` 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 `Profile` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateProfileWithRecordTypes
Description	Tests if this user can create a single `Profile` using the desired record types. While `ProfileManager.getProfileRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Profile.` Providing an empty array tests if a `Profile` can be created with no records.
Parameters	`osid.type.Type[]`	`profileRecordTypes`	array of profile recod types
Return	`boolean`		`true` if `Profile` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`profileRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProfileFormForCreate
Description	Gets the profile form for creating new profiles. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`profileRecordTypes`	array of profile recod types
Return	`osid.profile.ProfileForm`		the profile form
Errors	NULL_ARGUMENT		`profileRecordTypes` 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	createProfile
Description	Creates a new `Profile.`
Parameters	`osid.profile.ProfileForm`	`profileForm`	the form for this `Profile`
Return	`osid.profile.Profile`		the new `Profile`
Errors	ILLEGAL_STATE		`profileForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`profileForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`profileForm` did not originate from `getProfileFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateProfiles
Description	Tests if this user can update `Profiles.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Profile` 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 `Profile` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProfileFormForUpdate
Description	Gets the profile form for updating an existing profile. A new profile form should be requested for each update transaction.
Parameters	`osid.id.Id`	`profileId`	the `Id` of the `Profile`
Return	`osid.profile.ProfileForm`		the profile form
Errors	NOT_FOUND		`profileId` is not found
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	updateProfile
Description	Updates an existing profile.
Parameters	`osid.profile.ProfileForm`	`profileForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`profileForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`profileForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`profileForm` did not originate from `getProfileFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteProfiles
Description	Tests if this user can delete profiles. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Profile` 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 `Profile` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteProfile
Description	Deletes a `Profile.`
Parameters	`osid.id.Id`	`profileId`	the `Id` of the `Profile` to remove
Errors	NOT_FOUND		`profileId` not found
	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageProfileAliases
Description	Tests if this user can manage `Id` aliases for `Profiles.` 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 `Profile` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasProfile
Description	Adds an `Id` to a `Profile` for the purpose of creating compatibility. The primary `Id` of the `Profile` 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 it is reassigned to the given profile `Id.`
Parameters	`osid.id.Id`	`profileId`	the `Id` of a `Profile`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`profileId` not found
	NULL_ARGUMENT		`profileId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.