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

Interface	osid.configuration.rules.ValueEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `ValueEnablers.` 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 value enabler methods in this session operate, retrieve and pertain to value enablers defined explicitly in the current configuration. Using an isolated view is useful for managing `ValueEnablers` with the `ValueEnablerAdminSession.` federated configuration view: All value enabler methods in this session operate, retrieve and pertain to all value enablers defined in this configuration and any other value enablers implicitly available in this configuration through configuration inheritence. active value enabler view: All value enabler lookup methods return active value enablers. any status value enabler view: value enablers of any active and insatcive 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	canLookupValueEnablers
Description	Tests if this user can perform `ValueEnablers` 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	useComparativeValueEnablerView
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	usePlenaryValueEnablerView
Description	A complete view of the `ValueEnabler` 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 value 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	useActiveValueEnablerView
Description	Only active value enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusValueEnablerView
Description	All active and inactive value enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getValueEnabler
Description	Gets the `ValueEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `ValueEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `ValueEnabler` and retained for compatibility. In active mode, value enablers are returned that are currently active. In any status mode, active and inactive value enablers are returned.
Parameters	`osid.id.Id`	`valueEnablerId`	`Id` of the `ValueEnabler`
Return	`osid.configuration.rules.ValueEnabler`		the value enabler
Errors	NOT_FOUND		`valueEnablerId` not found
	NULL_ARGUMENT		`valueEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getValueEnablersByIds
Description	Gets a `ValueEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the value 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 `ValueEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, value enablers are returned that are currently active. In any status mode, active and inactive value enablers are returned.
Parameters	`osid.id.IdList`	`valueEnablerIds`	the list of `Ids` to retrieve
Return	`osid.configuration.rules.ValueEnablerList`		the returned `ValueEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`valueEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getValueEnablersByGenusType
Description	Gets a `ValueEnablerList` corresponding to the given value enabler genus `Type` which does not include value enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known value enablers or an error results. Otherwise, the returned list may contain only those value enablers that are accessible through this session. In active mode, value enablers are returned that are currently active. In any status mode, active and inactive value enablers are returned.
Parameters	`osid.type.Type`	`valueEnablerGenusType`	a value enabler genus type
Return	`osid.configuration.rules.ValueEnablerList`		the returned `ValueEnabler` list
Errors	NULL_ARGUMENT		`valueEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getValueEnablersByParentGenusType
Description	Gets a `ValueEnablerList` corresponding to the given value enabler genus `Type` and include any additional value enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known value enablers or an error results. Otherwise, the returned list may contain only those value enablers that are accessible through this session. In active mode, value enablers are returned that are currently active. In any status mode, active and inactive value enablers are returned.
Parameters	`osid.type.Type`	`valueEnablerGenusType`	a value enabler genus type
Return	`osid.configuration.rules.ValueEnablerList`		the returned `ValueEnabler` list
Errors	NULL_ARGUMENT		`valueEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getValueEnablersByRecordType
Description	Gets a `ValueEnablerList` containing the given value enabler record `Type.` In plenary mode, the returned list contains all known value enablers or an error results. Otherwise, the returned list may contain only those value enablers that are accessible through this session. In active mode, value enablers are returned that are currently active. In any status mode, active and inactive value enablers are returned.
Parameters	`osid.type.Type`	`valueEnablerRecordType`	a value enabler record type
Return	`osid.configuration.rules.ValueEnablerList`		the returned `ValueEnabler` list
Errors	NULL_ARGUMENT		`valueEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getValueEnablersOnDate
Description	Gets a `ValueEnablerList` effective within the given date range which are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known value enablers or an error results. Otherwise, the returned list may contain only those value enablers that are accessible through this session. In active mode, value enablers are returned that are currently active. In any status mode, active and inactive value enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.configuration.rules.ValueEnablerList`		the returned `ValueEnabler` 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	getValueEnablersOnDateWithAgent
Description	Gets a `ValueEnablerList` effective within the given date range which are effective for the entire given date range inclusive but not confined to the date range and evaluated for the given agent. In plenary mode, the returned list contains all known value enablers or an error results. Otherwise, the returned list may contain only those value enablers that are accessible through this session. In active mode, value enablers are returned that are currently active. In any status mode, active and inactive value 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.ValueEnablerList`		the returned `ValueEnabler` 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	getValueEnablers
Description	Gets all `ValueEnablers.` In plenary mode, the returned list contains all known value enablers or an error results. Otherwise, the returned list may contain only those value enablers that are accessible through this session. In active mode, value enablers are returned that are currently active. In any status mode, active and inactive value enablers are returned.
Return	`osid.configuration.rules.ValueEnablerList`		the returned `ValueEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.