org.osid.control

Interface SceneLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface SceneLookupSession
extends OsidSession

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 Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupScenes() Tests if this user can perform Scene lookups.
Scene	getScene(Id sceneId) Gets the Scene specified by its Id.
SceneList	getScenes() Gets all scenes.
SceneList	getScenesByGenusType(Type sceneGenusType) Gets a SceneList corresponding to the given scene genus Type which does not include scenes of types derived from the specified Type.
SceneList	getScenesByIds(IdList sceneIds) Gets a SceneList corresponding to the given IdList.
SceneList	getScenesByParentGenusType(Type sceneGenusType) Gets a SceneList corresponding to the given scene genus Type and include any additional scenes with genus types derived from the specified Type.
SceneList	getScenesByRecordType(Type sceneRecordType) Gets a SceneList containing the given scene record Type.
SceneList	getScenesBySetting(Id settingId) Gets a list of scenes by a setting.
System	getSystem() Gets the System associated with this session.
Id	getSystemId() Gets the System Id associated with this session.
void	useComparativeSceneView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	useFederatedSystemView() Federates the view for methods in this session.
void	useIsolatedSystemView() Isolates the view for methods in this session.
void	usePlenarySceneView() A complete view of the Scene returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getSystemId

Id getSystemId()

Gets the System Id associated with this session.

Returns:

the System Id associated with this session

Compliance:

mandatory - This method must be implemented.

getSystem

System getSystem()
                 throws OperationFailedException,
                        PermissionDeniedException

Gets the System associated with this session.

Returns:

the system

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupScenes

boolean canLookupScenes()

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.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeSceneView

void useComparativeSceneView()

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.

usePlenarySceneView

void usePlenarySceneView()

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.

useFederatedSystemView

void useFederatedSystemView()

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.

useIsolatedSystemView

void useIsolatedSystemView()

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.

getScene

Scene getScene(Id sceneId)
               throws NotFoundException,
                      OperationFailedException,
                      PermissionDeniedException

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:

sceneId - the Id of the Scene to retrieve

Returns:

the returned Scene

Throws:

NotFoundException - no Scene found with the given Id

NullArgumentException - sceneId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getScenesByIds

SceneList getScenesByIds(IdList sceneIds)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

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:

sceneIds - the list of Ids to retrieve

Returns:

the returned Scene list

Throws:

NotFoundException - an Id was not found

NullArgumentException - sceneIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getScenesByGenusType

SceneList getScenesByGenusType(Type sceneGenusType)
                               throws OperationFailedException,
                                      PermissionDeniedException

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:

sceneGenusType - a scene genus type

Returns:

the returned Scene list

Throws:

NullArgumentException - sceneGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getScenesByParentGenusType

SceneList getScenesByParentGenusType(Type sceneGenusType)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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:

sceneGenusType - a scene genus type

Returns:

the returned Scene list

Throws:

NullArgumentException - sceneGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getScenesByRecordType

SceneList getScenesByRecordType(Type sceneRecordType)
                                throws OperationFailedException,
                                       PermissionDeniedException

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:

sceneRecordType - a scene record type

Returns:

the returned Scene list

Throws:

NullArgumentException - sceneRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getScenesBySetting

SceneList getScenesBySetting(Id settingId)
                             throws OperationFailedException,
                                    PermissionDeniedException

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:

settingId - a setting Id

Returns:

the returned Scene list

Throws:

NullArgumentException - settingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getScenes

SceneList getScenes()
                    throws OperationFailedException,
                           PermissionDeniedException

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.

Returns:

the returned Scene list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.