OSID - osid.control.InputLookupSession Service Interface Definition

Interface	osid.control.InputLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Input` objects. The `Input` represents a fixed connection between two `Scenes.` 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 trigger view: All input methods in this session operate, retrieve and pertain to inputs defined explicitly in the current trigger. Using an isolated view is useful for managing `Inputs` with the `InputAdminSession.` federated trigger view: All input methods in this session operate, retrieve and pertain to all inputs defined in this trigger and any other inputs implicitly available in this trigger through trigger inheritence. effective input view: All input lookup methods return inputs where the current date falls in between the effective dates inclusive. any effective input view: input of any effective date 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 `useFederatedSystemView()` and `useIsolatedSystemView()` behave as a radio group and one should be selected before invoking any lookup methods.
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	canLookupInputs
Description	Tests if this user can perform `Input` 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	useComparativeInputView
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	usePlenaryInputView
Description	A complete view of the `Input` 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 inputs in systems which are children of this trigger 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	useEffectiveInputView
Description	Only inputs whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveInputView
Description	All input of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getInput
Description	Gets the `Input` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Input` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Input` and retained for compatibility. In effective mode, inputs are returned whose effective dates fall within the current date inclusive. In any effective mode, effective and expired inputs are returned.
Parameters	`osid.id.Id`	`inputId`	`Id` of the `Input`
Return	`osid.control.Input`		the input
Errors	NOT_FOUND		`inputId` not found
	NULL_ARGUMENT		`inputId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getInputsByIds
Description	Gets a `InputList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the inputs 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 `Inputs` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, inputs are returned whose effective dates fall within the current date inclusive. In any effective mode, effective and expired inputs are returned.
Parameters	`osid.id.IdList`	`inputIds`	the list of `Ids` to retrieve
Return	`osid.control.InputList`		the returned `Input` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`inputIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInputsByGenusType
Description	Gets a `InputList` corresponding to the given input genus `Type` which does not include inputs of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known inputs or an error results. Otherwise, the returned list may contain only those inputs that are accessible through this session. In effective mode, inputs are returned whose effective dates fall within the current date inclusive. In any effective mode, effective and expired inputs are returned.
Parameters	`osid.type.Type`	`inputGenusType`	an input genus type
Return	`osid.control.InputList`		the returned `Input` list
Errors	NULL_ARGUMENT		`inputGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInputsByParentGenusType
Description	Gets a `InputList` corresponding to the given input genus `Type` and include any additional inputs with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known inputs or an error results. Otherwise, the returned list may contain only those inputs that are accessible through this session. In effective mode, inputs are returned whose effective dates fall within the current date inclusive. In any effective mode, effective and expired inputs are returned.
Parameters	`osid.type.Type`	`inputGenusType`	an input genus type
Return	`osid.control.InputList`		the returned `Input` list
Errors	NULL_ARGUMENT		`inputGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInputsByRecordType
Description	Gets a `InputList` containing the given input record `Type.` In plenary mode, the returned list contains all known inputs or an error results. Otherwise, the returned list may contain only those inputs that are accessible through this session. In effective mode, inputs are returned whose effective dates fall within the current date inclusive. In any effective mode, effective and expired inputs are returned.
Parameters	`osid.type.Type`	`inputRecordType`	an input record type
Return	`osid.control.InputList`		the returned `Input` list
Errors	NULL_ARGUMENT		`inputRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInputsOnDate
Description	Gets a list of inputs effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known inputs or an error results. Otherwise, the returned list may contain only those inputs that are accessible through this session. In effective mode, inputs are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective inputs and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	start of date range
Parameters	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.control.InputList`		the returned `Input` 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	getInputsForDevice
Description	Gets a list of inputs for a device. In plenary mode, the returned list contains all known inputs or an error results. Otherwise, the returned list may contain only those inputs that are accessible through this session. In effective mode, inputs are returned that are currently effective. In any effective mode, effective inputs and those currently expired are returned.
Parameters	`osid.id.Id`	`deviceId`	a device `Id`
Return	`osid.control.InputList`		the returned `Input` list
Errors	NULL_ARGUMENT		`deviceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInputsForDeviceOnDate
Description	Gets a list of inputs for a device and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known inputs or an error results. Otherwise, the returned list may contain only those inputs that are accessible through this session. In effective mode, inputs are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective inputs and those currently expired are returned.
Parameters	`osid.id.Id`	`deviceId`	a device `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.control.InputList`		the returned `Input` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`deviceId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInputsForController
Description	Gets a list of inputs for a controller. In plenary mode, the returned list contains all known inputs or an error results. Otherwise, the returned list may contain only those inputs that are accessible through this session. In effective mode, inputs are returned that are currently effective. In any effective mode, effective inputs and those currently expired are returned.
Parameters	`osid.id.Id`	`controllerId`	a controller `Id`
Return	`osid.control.InputList`		the returned `Input` list
Errors	NULL_ARGUMENT		`controllerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInputsForControllerOnDate
Description	Gets a list of inputs for a controller and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known inputs or an error results. Otherwise, the returned list may contain only those inputs that are accessible through this session. In effective mode, inputs are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective inputs and those currently expired are returned.
Parameters	`osid.id.Id`	`controllerId`	a controller `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.control.InputList`		the returned `Input` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`controllerId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInputsForDeviceAndController
Description	Gets a list of inputs for a device and controller. In plenary mode, the returned list contains all known inputs or an error results. Otherwise, the returned list may contain only those inputs that are accessible through this session. In effective mode, inputs are returned that are currently effective. In any effective mode, effective inputs and those currently expired are returned.
Parameters	`osid.id.Id`	`deviceId`	a device `Id`
Parameters	`osid.id.Id`	`controllerId`	a controller `Id`
Return	`osid.control.InputList`		the returned `Input` list
Errors	NULL_ARGUMENT		`deviceId` or `controllerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInputsForDeviceAndControllerOnDate
Description	Gets a list of inputs for the device and controller and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known inputs or an error results. Otherwise, the returned list may contain only those inputs that are accessible through this session. In effective mode, inputs are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective inputs and those currently expired are returned.
Parameters	`osid.id.Id`	`deviceId`	a device `Id`
	`osid.id.Id`	`controllerId`	a controller `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.control.InputList`		the returned `Input` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`device, controllerId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInputs
Description	Gets all `Inputs.` In plenary mode, the returned list contains all known inputs or an error results. Otherwise, the returned list may contain only those inputs that are accessible through this session. In effective mode, inputs are returned that are currently effective. In any effective mode, effective inputs and those currently expired are returned.
Return	`osid.control.InputList`		a list of `Inputs`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.