OSID - osid.control.ControllerLookupSession Service Interface Definition

Interface	osid.control.ControllerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Controllers.` The `Controller` represents a set of actions `.` 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 controller methods in this session operate, retrieve and pertain to controllers defined explicitly in the current system. Using an isolated view is useful for managing `Controllers` with the `ControllerAdminSession.` federated system view: All controller methods in this session operate, retrieve and pertain to all controllers defined in this system and any other controllers implicitly available in this system through system inheritence. active controller view: active controllers are returned from methods in this session any status controller view: active and inactive controllers are returned from methods in this session 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 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	canLookupControllers
Description	Tests if this user can perform `Controller` 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	useComparativeControllerView
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	usePlenaryControllerView
Description	A complete view of the `ControllerConstrainer` 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 controller constrainers 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	useActiveControllerView
Description	Only active controllers are returned from methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusControllerView
Description	Borth active and inactive controllers are returned from methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getController
Description	Gets the `Controller` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Controller` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Controller` and retained for compatibility. In active mode, controllers are returned that are currently active. In any status mode, active and inactive controllers are returned.
Parameters	`osid.id.Id`	`controllerId`	`Id` of the `Controller`
Return	`osid.control.Controller`		the controller
Errors	NOT_FOUND		`controllerId` not found
	NULL_ARGUMENT		`controllerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getControllersByIds
Description	Gets a `ControllerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the controllers 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 `Controllers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, controllers are returned that are currently active. In any status mode, active and inactive controllers are returned.
Parameters	`osid.id.IdList`	`controllerIds`	the list of `Ids` to retrieve
Return	`osid.control.ControllerList`		the returned `Controller` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`controllerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getControllersByGenusType
Description	Gets a `ControllerList` corresponding to the given controller genus `Type` which does not include controllers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known controllers or an error results. Otherwise, the returned list may contain only those controllers that are accessible through this session. In active mode, controllers are returned that are currently active. In any status mode, active and inactive controllers are returned.
Parameters	`osid.type.Type`	`controllerGenusType`	a controller genus type
Return	`osid.control.ControllerList`		the returned `Controller` list
Errors	NULL_ARGUMENT		`controllerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getControllersByParentGenusType
Description	Gets a `ControllerList` corresponding to the given controller genus `Type` and include any additional controllers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known controllers or an error results. Otherwise, the returned list may contain only those controllers that are accessible through this session. In active mode, controllers are returned that are currently active. In any status mode, active and inactive controllers are returned.
Parameters	`osid.type.Type`	`controllerGenusType`	a controller genus type
Return	`osid.control.ControllerList`		the returned `Controller` list
Errors	NULL_ARGUMENT		`controllerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getControllersByRecordType
Description	Gets a `ControllerList` containing the given controller record `Type.` In plenary mode, the returned list contains all known controllers or an error results. Otherwise, the returned list may contain only those controllers that are accessible through this session. In active mode, controllers are returned that are currently active. In any status mode, active and inactive controllers are returned.
Parameters	`osid.type.Type`	`controllerRecordType`	a controller record type
Return	`osid.control.ControllerList`		the returned `Controller` list
Errors	NULL_ARGUMENT		`controllerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getControllersByAddress
Description	Gets a `ControllerList` with the given address. In plenary mode, the returned list contains all known controllers or an error results. Otherwise, the returned list may contain only those controllers that are accessible through this session. In active mode, controllers are returned that are currently active. In any status mode, active and inactive controllers are returned.
Parameters	`string`	`address`	a controller address
Return	`osid.control.ControllerList`		the returned `Controller` list
Errors	NULL_ARGUMENT		`address` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getControllers
Description	Gets all `Controllers.` In plenary mode, the returned list contains all known controllers or an error results. Otherwise, the returned list may contain only those controllers that are accessible through this session. In active mode, controllers are returned that are currently active. In any status mode, active and inactive controllers are returned.
Return	`osid.control.ControllerList`		a list of `Controllers`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.