OSID - osid.control.DeviceLookupSession Service Interface Definition

Interface	osid.control.DeviceLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Device` objects. The `Device` represents a fixed connection between two `Devices.` 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 device methods in this session operate, retrieve and pertain to devices defined explicitly in the current system. Using an isolated view is useful for managing `Devices` with the `DeviceAdminSession.` federated system view: All device methods in this session operate, retrieve and pertain to all devices defined in this system and any other devices implicitly available in this system through system inheritence. 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	canLookupDevices
Description	Tests if this user can perform `Device` 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	useComparativeDeviceView
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	usePlenaryDeviceView
Description	A complete view of the `Device` 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 devices 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	getDevice
Description	Gets the `Device` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Device` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Device` and retained for compatibility.
Parameters	`osid.id.Id`	`deviceId`	`Id` of the `Device`
Return	`osid.control.Device`		the device
Errors	NOT_FOUND		`deviceId` not found
	NULL_ARGUMENT		`deviceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getDevicesByIds
Description	Gets a `DeviceList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the devices 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 `Devices` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`deviceIds`	the list of `Ids` to retrieve
Return	`osid.control.DeviceList`		the returned `Device` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`deviceIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDevicesByGenusType
Description	Gets a `DeviceList` corresponding to the given device genus `Type` which does not include devices of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known devices or an error results. Otherwise, the returned list may contain only those devices that are accessible through this session.
Parameters	`osid.type.Type`	`deviceGenusType`	a device genus type
Return	`osid.control.DeviceList`		the returned `Device` list
Errors	NULL_ARGUMENT		`deviceGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDevicesByParentGenusType
Description	Gets a `DeviceList` corresponding to the given device genus `Type` and include any additional devices with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known devices or an error results. Otherwise, the returned list may contain only those devices that are accessible through this session.
Parameters	`osid.type.Type`	`deviceGenusType`	a device genus type
Return	`osid.control.DeviceList`		the returned `Device` list
Errors	NULL_ARGUMENT		`deviceGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDevicesByRecordType
Description	Gets a `DeviceList` containing the given device record `Type.` In plenary mode, the returned list contains all known devices or an error results. Otherwise, the returned list may contain only those devices that are accessible through this session.
Parameters	`osid.type.Type`	`deviceRecordType`	a device record type
Return	`osid.control.DeviceList`		the returned `Device` list
Errors	NULL_ARGUMENT		`deviceRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDevices
Description	Gets all `Devices.` In plenary mode, the returned list contains all known devices or an error results. Otherwise, the returned list may contain only those devices that are accessible through this session.
Return	`osid.control.DeviceList`		a list of `Devices`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.