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

Interface	osid.configuration.rules.ParameterProcessorAdminSession
Implements	`osid.OsidSession`
Used By	`osid.configuration.rules.ConfigurationRulesManager`
Used By	`osid.configuration.rules.ConfigurationRulesProxyManager`
Description	This session creates and removes parameter processors. The data for create and update is provided via the `ParameterProcessorForm`.
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	canCreateParameterProcessor
Description	Tests if this user can create parameter processors. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `ParameterProcessor` 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 `ParameterProcessor` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateParameterProcessorWithRecordTypes
Description	Tests if this user can create a single `ParameterProcessor` using the desired record types. While `ConfigurationRulesManager.getParameterProcessorRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `ParameterProcessor`. Providing an empty array tests if a `ParameterProcessor` can be created with no records.
Parameters	`osid.type.Type[]`	`parameterProcessorRecordTypes`	array of parameter processor record types
Return	`boolean`		`true` if `ParameterProcessor` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`parameterProcessorRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getParameterProcessorFormForCreate
Description	Gets the parameter processor form for creating new parameter processors. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`parameterProcessorRecordTypes`	array of parameter processor record types
Return	`osid.configuration.rules.ParameterProcessorForm`		the parameter processor form
Errors	NULL_ARGUMENT		`parameterProcessorRecordTypes` 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	createParameterProcessor
Description	Creates a new `ParameterProcessor`.
Parameters	`osid.configuration.rules.ParameterProcessorForm`	`parameterProcessorForm`	the form for this `ParameterProcessor`
Return	`osid.configuration.rules.ParameterProcessor`		the new `ParameterProcessor`
Errors	ILLEGAL_STATE		`parameterProcessorForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`parameterProcessorForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`parameterProcessorForm` did not originate from `getParameterProcessorFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateParameterProcessors
Description	Tests if this user can update parameter processors. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `ParameterProcessor` 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 `ParameterProcessor` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getParameterProcessorFormForUpdate
Description	Gets the parameter processor form for updating an existing parameter processor. A new parameter processor form should be requested for each update transaction.
Parameters	`osid.id.Id`	`parameterProcessorId`	the `Id` of the `ParameterProcessor`
Return	`osid.configuration.rules.ParameterProcessorForm`		the parameter processor form
Errors	NOT_FOUND		`parameterProcessorId` is not found
	NULL_ARGUMENT		`parameterProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateParameterProcessor
Description	Updates an existing parameter processor.
Parameters	`osid.configuration.rules.ParameterProcessorForm`	`parameterProcessorForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`parameterProcessorForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`parameterProcessorForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`parameterProcessorForm` did not originate from `getParameterProcessorFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteParameterProcessors
Description	Tests if this user can delete parameter processors. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `ParameterProcessor` 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 `ParameterProcessor` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteParameterProcessor
Description	Deletes a `ParameterProcessor`.
Parameters	`osid.id.Id`	`parameterProcessorId`	the `Id` of the `ParameterProcessor` to remove
Errors	NOT_FOUND		`parameterProcessorId` not found
	NULL_ARGUMENT		`parameterProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageParameterProcessorAliases
Description	Tests if this user can manage `Id` aliases for parameter processors. 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 `ParameterProcessor` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasParameterProcessor
Description	Adds an `Id` to a `ParameterProcessor` for the purpose of creating compatibility. The primary `Id` of the `ParameterProcessor` 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. it is reassigned to the given parameter processor `Id`.
Parameters	`osid.id.Id`	`parameterProcessorId`	the `Id` of a `ParameterProcessor`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`parameterProcessorId` not found
	NULL_ARGUMENT		`parameterProcessorId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.