Interface | osid.control.SceneSystemSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupSceneSystemScenes | ||
Description |
Tests if this user can perform lookups of scene/system
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known lookup methods in this session will result in a
| ||
Return | boolean | false if looking up scenes is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeSceneSystemView | ||
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 | usePlenarySceneSystemView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getSceneIdsBySystem | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | systemId | Id of the System |
Return | osid.id.IdList | list of related scene Ids | |
Errors | NOT_FOUND | systemId is not found | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getScenesBySystem | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | systemId | Id of the System |
Return | osid.control.SceneList | list of related scenes | |
Errors | NOT_FOUND | systemId is not found | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSceneIdsBySystems | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | systemIds | list of system Ids |
Return | osid.id.IdList | list of scene Ids | |
Errors | NULL_ARGUMENT | systemIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getScenesBySystems | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | systemIds | list of system Ids |
Return | osid.control.SceneList | list of scenes | |
Errors | NULL_ARGUMENT | systemIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSystemIdsByScene | ||
Description |
Gets the | ||
Parameters | osid.id.Id | sceneId | Id of a Scene |
Return | osid.id.IdList | list of systems | |
Errors | NOT_FOUND | sceneId is not found | |
NULL_ARGUMENT | sceneId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSystemsByScene | ||
Description |
Gets the | ||
Parameters | osid.id.Id | sceneId | Id of a Scene |
Return | osid.control.SystemList | list of systems | |
Errors | NOT_FOUND | sceneId is not found | |
NULL_ARGUMENT | sceneId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |