OSID - osid.control.rules.InputEnablerLookupSession Service Interface Definition

Interface	osid.control.rules.InputEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `InputEnablers.` 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 system view: All input enabler methods in this session operate, retrieve and pertain to input enablers defined explicitly in the current system. Using an isolated view is useful for managing `InputEnablers` with the `InputEnablerAdminSession.` federated system view: All input enabler methods in this session operate, retrieve and pertain to all input enablers defined in this system and any other input enablers implicitly available in this system through system inheritence. active input enabler view: All input enabler lookup methods return active input enablers. any status input enabler view: input 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	getSystemId
Description	Gets the `System` `Id` associated with this session.
Return	`osid.id.Id`		the `System Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getSystem
Description	Gets the `System` associated with this session.
Return	`osid.control.System`		the system
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupInputEnablers
Description	Tests if this user can perform `InputEnablers` 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	useComparativeInputEnablerView
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	usePlenaryInputEnablerView
Description	A complete view of the `InputEnabler` 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	useFederatedSystemView
Description	Federates the view for methods in this session. A federated view will include input enablers in systems which are children of this system in the system hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedSystemView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this system only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveInputEnablerView
Description	Only active input enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusInputEnablerView
Description	All active and inactive input enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getInputEnabler
Description	Gets the `InputEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `InputEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `InputEnabler` and retained for compatibility. In active mode, input enablers are returned that are currently active. In any status mode, active and inactive input enablers are returned.
Parameters	`osid.id.Id`	`inputEnablerId`	`Id` of the `InputEnabler`
Return	`osid.control.rules.InputEnabler`		the input enabler
Errors	NOT_FOUND		`inputEnablerId` not found
	NULL_ARGUMENT		`inputEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getInputEnablersByIds
Description	Gets an `InputEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the input 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 `InputEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, input enablers are returned that are currently active. In any status mode, active and inactive input enablers are returned.
Parameters	`osid.id.IdList`	`inputEnablerIds`	the list of `Ids` to retrieve
Return	`osid.control.rules.InputEnablerList`		the returned `InputEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`inputEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInputEnablersByGenusType
Description	Gets an `InputEnablerList` corresponding to the given input enabler genus `Type` which does not include input enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known input enablers or an error results. Otherwise, the returned list may contain only those input enablers that are accessible through this session. In active mode, input enablers are returned that are currently active. In any status mode, active and inactive input enablers are returned.
Parameters	`osid.type.Type`	`inputEnablerGenusType`	an input enabler genus type
Return	`osid.control.rules.InputEnablerList`		the returned `InputEnabler` list
Errors	NULL_ARGUMENT		`inputEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInputEnablersByParentGenusType
Description	Gets an `InputEnablerList` corresponding to the given input enabler genus `Type` and include any additional input enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known input enablers or an error results. Otherwise, the returned list may contain only those input enablers that are accessible through this session. In active mode, input enablers are returned that are currently active. In any status mode, active and inactive input enablers are returned.
Parameters	`osid.type.Type`	`inputEnablerGenusType`	an input enabler genus type
Return	`osid.control.rules.InputEnablerList`		the returned `InputEnabler` list
Errors	NULL_ARGUMENT		`inputEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInputEnablersByRecordType
Description	Gets an `InputEnablerList` containing the given input enabler record `Type.` In plenary mode, the returned list contains all known input enablers or an error results. Otherwise, the returned list may contain only those input enablers that are accessible through this session. In active mode, input enablers are returned that are currently active. In any status mode, active and inactive input enablers are returned.
Parameters	`osid.type.Type`	`inputEnablerRecordType`	an input enabler record type
Return	`osid.control.rules.InputEnablerList`		the returned `InputEnabler` list
Errors	NULL_ARGUMENT		`inputEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInputEnablersOnDate
Description	Gets an `InputEnablerList` effective within the given date range. In plenary mode, the returned list contains all known input enablers or an error results. Otherwise, the returned list may contain only those input enablers that are accessible through this session. In active mode, input enablers are returned that are currently active. In any status mode, active and inactive input enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.control.rules.InputEnablerList`		the returned `InputEnabler` 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	getInputEnablersOnDateWithAgent
Description	Gets an `InputEnablerList` effective during 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 input enablers or an error results. Otherwise, the returned list may contain only those input enablers that are accessible through this session. In active mode, input enablers are returned that are currently active. In any status mode, active and inactive input 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.control.rules.InputEnablerList`		the returned `InputEnabler` 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	getInputEnablers
Description	Gets all `InputEnablers.` In plenary mode, the returned list contains all known input enablers or an error results. Otherwise, the returned list may contain only those input enablers that are accessible through this session. In active mode, input enablers are returned that are currently active. In any status mode, active and inactive input enablers are returned.
Return	`osid.control.rules.InputEnablerList`		the returned `InputEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.