OSID - osid.configuration.rules.ParameterProcessorEnablerAdminSession Service Interface Definition

Interface	osid.configuration.rules.ParameterProcessorEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.configuration.rules.ConfigurationRulesManager`
Used By	`osid.configuration.rules.ConfigurationRulesProxyManager`
Description	This session creates and removes parameter processor enablers. The data for create and update is provided via the `ParameterProcessorEnablerForm`.
Method	getConfigurationId
Description	Gets the `Configuration` `Id` associated with this session.
Return	`osid.id.Id`		the `Configuration Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getConfiguration
Description	Gets the `Configuration` associated with this session.
Return	`osid.configuration.Configuration`		the configuration
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateParameterProcessorEnabler
Description	Tests if this user can create parameter processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `ParameterProcessorEnabler` 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 `ParameterProcessorEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateParameterProcessorEnablerWithRecordTypes
Description	Tests if this user can create a single `ParameterProcessorEnabler` using the desired record types. While `ConfigurationRulesManager.getParameterProcessorEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `ParameterProcessorEnabler`. Providing an empty array tests if a `ParameterProcessorEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`parameterProcessorEnablerRecordTypes`	array of parameter processor enabler record types
Return	`boolean`		`true` if `ParameterProcessorEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`parameterProcessorEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getParameterProcessorEnablerFormForCreate
Description	Gets the parameter processor enabler form for creating new parameter processor enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`parameterProcessorEnablerRecordTypes`	array of parameter processor enabler record types
Return	`osid.configuration.rules.ParameterProcessorEnablerForm`		the parameter processor enabler form
Errors	NULL_ARGUMENT		`parameterProcessorEnablerRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createParameterProcessorEnabler
Description	Creates a new `ParameterProcessorEnabler`.
Parameters	`osid.configuration.rules.ParameterProcessorEnablerForm`	`parameterProcessorEnablerForm`	the form for this `ParameterProcessorEnabler`
Return	`osid.configuration.rules.ParameterProcessorEnabler`		the new `ParameterProcessorEnabler`
Errors	ILLEGAL_STATE		`parameterProcessorEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`parameterProcessorEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`parameterProcessorEnablerForm` did not originate from `getParameterProcessorEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateParameterProcessorEnablers
Description	Tests if this user can update parameter processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `ParameterProcessorEnabler` 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 `ParameterProcessorEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getParameterProcessorEnablerFormForUpdate
Description	Gets the parameter processor enabler form for updating an existing parameter processor enabler. A new parameter processor enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`parameterProcessorEnablerId`	the `Id` of the `ParameterProcessorEnabler`
Return	`osid.configuration.rules.ParameterProcessorEnablerForm`		the parameter processor enabler form
Errors	NOT_FOUND		`parameterProcessorEnablerId` is not found
	NULL_ARGUMENT		`parameterProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateParameterProcessorEnabler
Description	Updates an existing parameter processor enabler.
Parameters	`osid.configuration.rules.ParameterProcessorEnablerForm`	`parameterProcessorEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`parameterProcessorEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`parameterProcessorEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`parameterProcessorEnablerForm` did not originate from `getParameterProcessorEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteParameterProcessorEnablers
Description	Tests if this user can delete parameter processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `ParameterProcessorEnabler` 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 `ParameterProcessorEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteParameterProcessorEnabler
Description	Deletes a `ParameterProcessorEnabler`.
Parameters	`osid.id.Id`	`parameterProcessorEnablerId`	the `Id` of the `ParameterProcessorEnabler` to remove
Errors	NOT_FOUND		`parameterProcessorEnablerId` not found
	NULL_ARGUMENT		`parameterProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageParameterProcessorEnablerAliases
Description	Tests if this user can manage `Id` aliases for parameter processor 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 `ParameterProcessorEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasParameterProcessorEnabler
Description	Adds an `Id` to a `ParameterProcessorEnabler` for the purpose of creating compatibility. The primary `Id` of the `ParameterProcessorEnabler` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another parameter processor enabler. it is reassigned to the given parameter processor enabler `Id`.
Parameters	`osid.id.Id`	`parameterProcessorEnablerId`	the `Id` of a `ParameterProcessorEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`parameterProcessorEnablerId` not found
	NULL_ARGUMENT		`parameterProcessorEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.