OSID - osid.control.SceneLookupSession Service Interface Definition

Interface	osid.control.SceneLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving scenes. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated system view: All scene methods in this session operate, retrieve and pertain to scenes defined explicitly in the current system. Using an isolated view is useful for managing `Scenes` with the `SceneAdminSession.` federated system view: All scene lookup methods in this session operate, retrieve and pertain to all scenes defined in this system and any other scenes implicitly available in this system through system inheritence. The methods `useFederatedSystemView()` and `useIsolatedSystemView()` behave as a radio group and one should be selected before invoking any lookup methods. Scenes may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the scenes.
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	canLookupScenes
Description	Tests if this user can perform `Scene` 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 not 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	useComparativeSceneView
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	usePlenarySceneView
Description	A complete view of the `Scene` 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 scenes 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 retrievals to this system only.
Compliance	`mandatory`		This method is must be implemented.
Method	getScene
Description	Gets the `Scene` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Scene` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Scene` and retained for compatibility.
Parameters	`osid.id.Id`	`sceneId`	the `Id` of the `Scene` to retrieve
Return	`osid.control.Scene`		the returned `Scene`
Errors	NOT_FOUND		no `Scene` found with the given `Id`
	NULL_ARGUMENT		`sceneId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getScenesByIds
Description	Gets a `SceneList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the scenes 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 `Scenes` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`sceneIds`	the list of `Ids` to retrieve
Return	`osid.control.SceneList`		the returned `Scene` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`sceneIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getScenesByGenusType
Description	Gets a `SceneList` corresponding to the given scene genus `Type` which does not include scenes of types derived from the specified `Type.` In plenary mode, the returned list contains all known scenes or an error results. Otherwise, the returned list may contain only those scenes that are accessible through this session.
Parameters	`osid.type.Type`	`sceneGenusType`	a scene genus type
Return	`osid.control.SceneList`		the returned `Scene` list
Errors	NULL_ARGUMENT		`sceneGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getScenesByParentGenusType
Description	Gets a `SceneList` corresponding to the given scene genus `Type` and include any additional scenes with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known scenes or an error results. Otherwise, the returned list may contain only those scenes that are accessible through this session.
Parameters	`osid.type.Type`	`sceneGenusType`	a scene genus type
Return	`osid.control.SceneList`		the returned `Scene` list
Errors	NULL_ARGUMENT		`sceneGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getScenesByRecordType
Description	Gets a `SceneList` containing the given scene record `Type.` In plenary mode, the returned list contains all known scenes or an error results. Otherwise, the returned list may contain only those scenes that are accessible through this session.
Parameters	`osid.type.Type`	`sceneRecordType`	a scene record type
Return	`osid.control.SceneList`		the returned `Scene` list
Errors	NULL_ARGUMENT		`sceneRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getScenesBySetting
Description	Gets a list of scenes by a setting. In plenary mode, the returned list contains all known scenes or an error results. Otherwise, the returned list may contain only those scenes that are accessible through this session.
Parameters	`osid.id.Id`	`settingId`	a setting `Id`
Return	`osid.control.SceneList`		the returned `Scene` list
Errors	NULL_ARGUMENT		`settingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getScenes
Description	Gets all scenes. In plenary mode, the returned list contains all of the scenes including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Scenes` may be omitted from the list and may present the elements in any order including returning a unique set.
Return	`osid.control.SceneList`		the returned `Scene` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.