OSID - osid.profile.rules.ProfileEntryEnablerAdminSession Service Interface Definition

Interface	osid.profile.rules.ProfileEntryEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.profile.rules.ProfileRulesManager`
Used By	`osid.profile.rules.ProfileRulesProxyManager`
Description	This session creates and removes profile entry enablers. The data for create and update is provided via the `ProfileEntryEnablerForm` .
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
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateProfileEntryEnabler
Description	Tests if this user can create profile entry enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `ProfileEntryEnabler` 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 `ProfileEntryEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateProfileEntryEnablerWithRecordTypes
Description	Tests if this user can create a single `ProfileEntryEnabler` using the desired record types. While `ProfileRulesManager.getProfileEntryEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `ProfileEntryEnabler` . Providing an empty array tests if a `ProfileEntryEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`profileEntryEnablerRecordTypes`	array of profile entry enabler types
Return	`boolean`		`true` if `ProfileEntryEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`profileEntryEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntryEnablerFormForCreate
Description	Gets the profile entry enabler form for creating new profile entry enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`profileEntryEnablerRecordTypes`	array of profile entry enabler types
Return	`osid.profile.rules.ProfileEntryEnablerForm`		the profile entry enabler form
Errors	NULL_ARGUMENT		`profileEntryEnablerRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unabel to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createProfileEntryEnabler
Description	Creates a new `ProfileEntryEnabler` .
Parameters	`osid.profile.rules.ProfileEntryEnablerForm`	`profileEntryEnablerForm`	the form for this `ProfileEntryEnabler`
Return	`osid.profile.rules.ProfileEntryEnabler`		the new `ProfileEntryEnabler`
Errors	ILLEGAL_STATE		`profileEntryEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`profileEntryEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`profileEntryEnablerForm` did not originate from `getProfileEntryEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateProfileEntryEnablers
Description	Tests if this user can update profile entry enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `ProfileEntryEnabler` 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 `ProfileEntryEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProfileEntryEnablerFormForUpdate
Description	Gets the profile entry enabler form for updating an existing profile entry enabler. A new profile entry enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`profileEntryEnablerId`	the `Id` of the `ProfileEntryEnabler`
Return	`osid.profile.rules.ProfileEntryEnablerForm`		the profile entry enabler form
Errors	NOT_FOUND		`profileEntryEnablerId` is not found
	NULL_ARGUMENT		`profileEntryEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateProfileEntryEnabler
Description	Updates an existing profile entry enabler.
Parameters	`osid.profile.rules.ProfileEntryEnablerForm`	`profileEntryEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`profileEntryEnablerForm` already used in an upate transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`profileEntryEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`profileEntryEnablerForm` did not originate from `getProfileEntryEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteProfileEntryEnablers
Description	Tests if this user can delete profile entry enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `ProfileEntryEnabler` 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 `ProfileEntryEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteProfileEntryEnabler
Description	Deletes a `ProfileEntryEnabler` .
Parameters	`osid.id.Id`	`profileEntryEnablerId`	the `Id` of the `ProfileEntryEnabler` to remove
Errors	NOT_FOUND		`profileEntryEnablerId` not found
	NULL_ARGUMENT		`profileEntryEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageProfileEntryEnablerAliases
Description	Tests if this user can manage `Id` aliases for profile entry enablers. 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 `ProfileEntryEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasProfileEntryEnabler
Description	Adds an `Id` to a `ProfileEntryEnabler` for the purpose of creating compatibility. The primary `Id` of the `ProfileEntryEnabler` 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 enabler. it is reassigned to the given profile entry enabler `Id` .
Parameters	`osid.id.Id`	`profileEntryEnablerId`	the `Id` of a `ProfileEntryEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`profileEntryEnablerId` not found
	NULL_ARGUMENT		`profileEntryEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.