OSID - osid.profile.ProfileEntryAdminSession Service Interface Definition

Interface	osid.profile.ProfileEntryAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.profile.batch.ProfileEntryBatchAdminSession`
Used By	`osid.profile.ProfileManager`
Used By	`osid.profile.ProfileProxyManager`
Description	This session creates and removes `ProfileEntries`. An `ProfileEntry` may be defined using an Agent or a Resource. Create and delete methods exist for each type desired. An explicit `ProfileEntry` is identified by the mapping among a `Resource/Agent` and `ProfileItem`. There can be only one explicit `ProfileEntry` for each triplet however multiple implicit `ProfileEntries` may exist. When a profile entry is created, it is disabled until `enableProfileEntry()` is used. Create and update operations differ in their usage. To create a `ProfileEntry`, a `ProfileEntryForm` is requested using `geProfileEntryFormFormForCreate()` specifying the profile item, resource or agent, and desired record `Types` or none if no record `Types` are needed. The returned `ProfileEntryForm` 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 `ProfileEntryForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `ProfileEntryForm` corresponds to an attempted transaction. For updates, `ProfileEntryForms` are requested to the `ProfileEntry` `Id` that is to be updated using `getProfileEntryFormForUpdate()`. Similarly, the `ProfileEntry` has metadata about the data that can be updated and it can perform validation before submitting the update. The `ProfileEntryForm` can only be used once for a successful update and cannot be reused. The delete operations delete `ProfileEntries`. To unmap a `ProfileEntry` from the current `Profile` the `ProfileEntryProfileAssignmentSession` should be used. These delete operations attempt to remove the `ProfileEntry` 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	canCreateProfileEntries
Description	Tests if this user can create `ProfileEntries`. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 create operations to unauthorized users.
Return	`boolean`		`false` if `ProfileEntry` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateProfileEntryWithRecordTypes
Description	Tests if this user can create a single `ProfileEntry` using the desired record types. While `ProfileManager.getProfileEntryRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `ProfileEntry`. Providing an empty array tests if a `ProfileEntry` can be created with no records.
Parameters	`osid.type.Type[]`	`profileEntryRecordTypes`	array of profile entry types
Return	`boolean`		`true` if `ProfileEntry` creation using the specified `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`profileEntryRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntryFormForCreateForAgent
Description	Gets the profile entry form for creating new profile entries. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`agentId`	the agent `Id`
	`osid.id.Id`	`profileItemId`	the profile item `Id`
	`osid.type.Type[]`	`profileEntryRecordTypes`	array of profile entry types
Return	`osid.profile.ProfileEntryForm`		the profile entry form
Errors	NOT_FOUND		`agentId` or `profileItemId` is not found
	NULL_ARGUMENT		`agentId` or `profileItemId` 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	getProfileEntryFormForCreateForResource
Description	Gets the profile entry form for creating new profile entries. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`resourceId`	the resource `Id`
Parameters	`osid.id.Id`	`profileItemId`	the profile item `Id`
Return	`osid.profile.ProfileEntryForm`		the profile entry form
Errors	NOT_FOUND		`resourceId` or `profileItemId` is not found
	NULL_ARGUMENT		`resourceId` or `profileItemId` is `null`
	OPERATION_FAILED		`unable to complete request`
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	createProfileEntry
Description	Creates a new `ProfileEntry`.
Parameters	`osid.profile.ProfileEntryForm`	`profileEntryForm`	the profile entry form
Return	`osid.profile.ProfileEntry`		`t` he new `ProfileEntry`
Errors	ILLEGAL_STATE		`profileEntryForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`profileEntryForm` `null`
	OPERATION_FAILED		`unable to complete request`
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`profileEntryForm` did not originate from `getprofileEntryFormForAgent()` or `getProfileEntryFormForResource()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateProfileEntries
Description	Tests if this user can update `ProfileEntries`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `ProfileEntry` 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 entry modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntryFormForUpdate
Description	Gets the profile entry form for updating an existing profile entry. A new profile entry form should be requested for each update transaction.
Parameters	`osid.id.Id`	`profileEntryId`	the `Id` of the `ProfileEntry`
Return	`osid.profile.ProfileEntryForm`		the profile entry form
Errors	NOT_FOUND		`profileEntryId` is not found
	NULL_ARGUMENT		`profileEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateProfileEntry
Description	Updates an existing profile entry.
Parameters	`osid.profile.ProfileEntryForm`	`profileEntryForm`	the profile entry form
Errors	ILLEGAL_STATE		`profileEntryForm` already used in an update transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`profileEntryForm` is `null`
	OPERATION_FAILED		`unable to complete request`
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`profileEntryForm` did not originate from `getProfileEntryFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteProfileEntries
Description	Tests if this user can delete `ProfileEntries`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `ProfileEntry` 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 `ProfileEntry` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteProfileEntry
Description	Deletes the `ProfileEntry` identified by the given `Id`.
Parameters	`osid.id.Id`	`profileEntryId`	the `Id` of the `ProfileEntry` to delete
Errors	NOT_FOUND		an `ProfileEntry` was not found identified by the given `Id`
	NULL_ARGUMENT		`profileEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageProfileEntryAliases
Description	Tests if this user can manage `Id` aliases for profile entries. 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 `ProfileEntry` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasProfileEntry
Description	Adds an `Id` to an `ProfileEntry` for the purpose of creating compatibility. The primary `Id` of the `ProfileEntry` 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 entry it is reassigned to the given profile entry `Id`.
Parameters	`osid.id.Id`	`profileEntryId`	the `Id` of an `ProfileEntry`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`profileEntryId` not found
	NULL_ARGUMENT		`profileEntryId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.