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

Interface	osid.configuration.rules.ParameterProcessorRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.configuration.rules.ConfigurationRulesManager`
Used By	`osid.configuration.rules.ConfigurationRulesProxyManager`
Description	This session provides methods to apply `ParameterProcessors` to `Parameters`.
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	canAssignParameterProcessors
Description	Tests if this user can alter parameter processor/parameter mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	assignParameterProcessorToParameter
Description	Adds an existing `ParameterProcessor` to a `Parameter`.
Parameters	`osid.id.Id`	`parameterProcessorId`	the `Id` of the `ParameterProcessor`
Parameters	`osid.id.Id`	`parameterId`	the `Id` of the `Parameter`
Errors	ALREADY_EXISTS		`parameterProcessorId` is already applied to `parameterId`
	NOT_FOUND		`parameterProcessorId` or `parameterId` not found
	NULL_ARGUMENT		`parameterProcessorId` or `parameterId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignParameterProcessorFromParameter
Description	Removes a `ParameterProcessor` from a `Parameter`.
Parameters	`osid.id.Id`	`parameterProcessorId`	the `Id` of the `ParameterProcessor`
Parameters	`osid.id.Id`	`parameterId`	the `Id` of the `Parameter`
Errors	NOT_FOUND		`parameterProcessorId` or `parameterId` not found or `parameterProcessorId` is not applied to `parameterId`
	NULL_ARGUMENT		`parameterProcessorId` or `parameterId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceParameterProcessors
Description	Tests if this user can order `ParametereProcessors`. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.
Return	`boolean`		`false` if `ParameterProcessor` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveParameterProcessorAhead
Description	Reorders parameter processors for a parameter by moving the specified parameter processors in front of a reference parameter.
Parameters	`osid.id.Id`	`parameterProcessorId`	the `Id` of a `ParameterProcessor`
	`osid.id.Id`	`parameterId`	the `Id` of a `Parameter`
	`osid.id.Id`	`referenceId`	the reference parameter processor `Id`
Errors	NOT_FOUND		`parameterProcessorId, parameterId`, or `referenceId` not found or, `parameterProcessorId`, or `referenceId` not related to `parameterId`
	NULL_ARGUMENT		`parameterProcessorId, parameterId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveParameterProcessorBehind
Description	Reorders parameter processors for a parameter by moving the specified parameter processor behind a reference parameter processor.
Parameters	`osid.id.Id`	`parameterProcessorId`	the `Id` of a `ParameterProcessor`
	`osid.id.Id`	`parameterId`	the `Id` of a `Parameter`
	`osid.id.Id`	`referenceId`	the reference parameter processor `Id`
Errors	NOT_FOUND		`parameterProcessorId, parameterId`, or `referenceId` not found or, `parameterProcessorId`, or `referenceId` not related to `parameterId`
	NULL_ARGUMENT		`parameterProcessorId, parameterId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderParameterProcessors
Description	Reorders a set of parameter processors for a parameter.
Parameters	`osid.id.Id[]`	`parameterProcessorIds`	the `Ids` for a set of `ParameterProcessors`
Parameters	`osid.id.Id`	`parameterId`	the `Id` of a `Parameter`
Errors	NOT_FOUND		`parameterId` not found or, a `parameterProcessorId` not related to `parameterId`
	NULL_ARGUMENT		`parameterProcessorIds` or `parameterId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.