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

Interface	osid.configuration.rules.ParameterProcessorRuleLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `ParameterProcessor` to `Parameter` mappings. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated configuration view: All methods in this session operate, retrieve and pertain parameter processor defined explicitly in the current configuration federated configuration view: All methods in this session operate, retrieve and pertain to all parameter processor defined in this configuration and any other parameter processor implicitly available in this configuration through configuration inheritence.
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	canLookupParameterProcessorRules
Description	Tests if this user can perform lookups of parameter processor/parameter mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeParameterProcessorRuleView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryParameterProcessorRuleView
Description	A complete view of the `ParameterProcessor` and `Parameter` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedConfigurationView
Description	Federates the view for methods in this session. A federated view will include parameter processor in configurations which are children of this configuration in the configuration hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedConfigurationView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this configuration only.
Compliance	`mandatory`		This method is must be implemented.
Method	getParameterProcessorIdsForParameter
Description	Gets the `ParameterProcessor Id` associated with a `Parameter.`
Parameters	`osid.id.Id`	`parameterId`	`Id` of the `Parameter`
Return	`osid.id.IdList`		the parameter processor `Ids`
Errors	NOT_FOUND		`parameterId` is not found
	NULL_ARGUMENT		`parameterId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParameterProcessorsForParameter
Description	Gets the `ParameterProcessor` associated with a `Parameter.`
Parameters	`osid.id.Id`	`parameterId`	`Id` of the `Parameter`
Return	`osid.configuration.rules.ParameterProcessorList`		the parameter processors
Errors	NOT_FOUND		`parameterId` is not found
	NULL_ARGUMENT		`parameterId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParameterIdsForParameterProcessor
Description	Gets the `Parameter` `Ids` mapped to an `ParameterProcessor.`
Parameters	`osid.id.Id`	`parameterProcessorId`	`Id` of an `ParameterProcessor`
Return	`osid.id.IdList`		list of parameter `Ids`
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	getParametersForParameterProcessor
Description	Gets the `Parameters` mapped to an `ParameterProcessor.`
Parameters	`osid.id.Id`	`parameterProcessorId`	`Id` of an `ParameterProcessor`
Return	`osid.configuration.ParameterList`		list of parameters
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.