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

Interface	osid.configuration.rules.ParameterProcessorEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `ParameterProcessorEnablers.` This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated configuration view: All parameter processor enabler methods in this session operate, retrieve and pertain to parameter processor enablers defined explicitly in the current configuration. Using an isolated view is useful for managing `ParameterProcessorEnablers` with the `ParameterProcessorEnablerAdminSession.` federated configuration view: All parameter processor enabler methods in this session operate, retrieve and pertain to all parameter processor enablers defined in this configuration and any other parameter processor enablers implicitly available in this configuration through configuration inheritence. active parameter processor enabler view: All parameter processor enabler lookup methods return active parameter processor enablers. any status parameter processor enabler view: Parameter processor enablers of any active or inactive status are returned from methods. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedDistributorView()` and `useIsolatedDistributorView()` behave as a radio group and one should be selected before invoking the methods in this session.
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	canLookupParameterProcessorEnablers
Description	Tests if this user can perform `ParameterProcessorEnablers` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeParameterProcessorEnablerView
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	usePlenaryParameterProcessorEnablerView
Description	A complete view of the `ParameterProcessorEnabler` 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 enablers 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	useActiveParameterProcessorEnablerView
Description	Only active parameter processor enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusParameterProcessorEnablerView
Description	All active and inactive parameter processor enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getParameterProcessorEnabler
Description	Gets the `ParameterProcessorEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `ParameterProcessorEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `ParameterProcessorEnabler` and retained for compatibility. In active mode, parameter processor enablers are returned that are currently active. In any status mode, active and inactive parameter processor enablers are returned.
Parameters	`osid.id.Id`	`parameterProcessorEnablerId`	`Id` of the `ParameterProcessorEnabler`
Return	`osid.configuration.rules.ParameterProcessorEnabler`		the parameter processor enabler
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 is must be implemented.
Method	getParameterProcessorEnablersByIds
Description	Gets a `ParameterProcessorEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the parameter processor enablers specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `ParameterProcessorEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, parameter processor enablers are returned that are currently active. In any status mode, active and inactive parameter processor enablers are returned.
Parameters	`osid.id.IdList`	`parameterProcessorEnablerIds`	the list of `Ids` to retrieve
Return	`osid.configuration.rules.ParameterProcessorEnablerList`		the returned `ParameterProcessorEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`parameterProcessorEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParameterProcessorEnablersByGenusType
Description	Gets a `ParameterProcessorEnablerList` corresponding to the given parameter processor enabler genus `Type` which does not include parameter processor enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known parameter processor enablers or an error results. Otherwise, the returned list may contain only those parameter processor enablers that are accessible through this session. In active mode, parameter processor enablers are returned that are currently active. In any status mode, active and inactive parameter processor enablers are returned.
Parameters	`osid.type.Type`	`parameterProcessorEnablerGenusType`	a parameter processor enabler genus type
Return	`osid.configuration.rules.ParameterProcessorEnablerList`		the returned `ParameterProcessorEnabler` list
Errors	NULL_ARGUMENT		`parameterProcessorEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParameterProcessorEnablersByParentGenusType
Description	Gets a `ParameterProcessorEnablerList` corresponding to the given parameter processor enabler genus `Type` and include any additional parameter processor enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known parameter processor enablers or an error results. Otherwise, the returned list may contain only those parameter processor enablers that are accessible through this session. In active mode, parameter processor enablers are returned that are currently active. In any status mode, active and inactive parameter processor enablers are returned.
Parameters	`osid.type.Type`	`parameterProcessorEnablerGenusType`	a parameter processor enabler genus type
Return	`osid.configuration.rules.ParameterProcessorEnablerList`		the returned `ParameterProcessorEnabler` list
Errors	NULL_ARGUMENT		`parameterProcessorEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParameterProcessorEnablersByRecordType
Description	Gets a `ParameterProcessorEnablerList` containing the given parameter processor enabler record `Type.` In plenary mode, the returned list contains all known parameter processor enablers or an error results. Otherwise, the returned list may contain only those parameter processor enablers that are accessible through this session. In active mode, parameter processor enablers are returned that are currently active. In any status mode, active and inactive parameter processor enablers are returned.
Parameters	`osid.type.Type`	`parameterProcessorEnablerRecordType`	a parameter processor enabler record type
Return	`osid.configuration.rules.ParameterProcessorEnablerList`		the returned `ParameterProcessorEnabler` list
Errors	NULL_ARGUMENT		`parameterProcessorEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParameterProcessorEnablersOnDate
Description	Gets a `ParameterProcessorEnablerList` that are effective for the entire given date range but not confined to the date range. In plenary mode, the returned list contains all known parameter processor enablers or an error results. Otherwise, the returned list may contain only those parameter processor enablers that are accessible through this session. In active mode, parameter processor enablers are returned that are currently active. In any status mode, active and inactive parameter processor enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.configuration.rules.ParameterProcessorEnablerList`		the returned `ParameterProcessorEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParameterProcessorEnablersOnDateWithAgent
Description	Gets a `ParameterProcessorEnablerList` that are effective for the entire given date range but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known parameter processor enablers or an error results. Otherwise, the returned list may contain only those parameter processor enablers that are accessible through this session. In active mode, parameter processor enablers are returned that are currently active. In any status mode, active and inactive parameter processor enablers are returned.
Parameters	`osid.id.Id`	`agentId`	an agent Id
	`osid.calendaring.DateTime`	`from`	a start date
	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.configuration.rules.ParameterProcessorEnablerList`		the returned `ParameterProcessorEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`agentId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getParameterProcessorEnablers
Description	Gets all `ParameterProcessorEnablers.` In plenary mode, the returned list contains all known parameter processor enablers or an error results. Otherwise, the returned list may contain only those parameter processor enablers that are accessible through this session. In active mode, parameter processor enablers are returned that are currently active. In any status mode, active and inactive parameter processor enablers are returned.
Return	`osid.configuration.rules.ParameterProcessorEnablerList`		the returned `ParameterProcessorEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.