Interface | osid.control.ControlManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.control.ControlProfile | |||
Description |
The control manager provides access to control sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
Method | getDeviceLookupSession | ||
Description |
Gets the | ||
Return | osid.control.DeviceLookupSession | a DeviceLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDeviceLookup() is false | ||
Compliance | optional | This method must be implemented if supportsDeviceLookup() is
true. | |
Method | getDeviceLookupSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.DeviceLookupSession | a DeviceLookupSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDeviceLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsDeviceLookup()
and supportsVisibleFederation() are true | |
Method | getDeviceQuerySession | ||
Description |
Gets the | ||
Return | osid.control.DeviceQuerySession | a DeviceQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDeviceQuery() is false | ||
Compliance | optional | This method must be implemented if supportsDeviceQuery() is
true. | |
Method | getDeviceQuerySessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.DeviceQuerySession | a DeviceQuerySession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDeviceQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsDeviceQuery() and
supportsVisibleFederation() are true | |
Method | getDeviceSearchSession | ||
Description |
Gets the | ||
Return | osid.control.DeviceSearchSession | a DeviceSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDeviceSearch() is false | ||
Compliance | optional | This method must be implemented if supportsDeviceSearch() is
true. | |
Method | getDeviceSearchSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.DeviceSearchSession | a DeviceSearchSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDeviceSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsDeviceSearch()
and supportsVisibleFederation() are true | |
Method | getDeviceAdminSession | ||
Description |
Gets the | ||
Return | osid.control.DeviceAdminSession | a DeviceAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDeviceAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsDeviceAdmin() is
true. | |
Method | getDeviceAdminSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.DeviceAdminSession | a DeviceAdminSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDeviceAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsDeviceAdmin() and
supportsVisibleFederation() are true | |
Method | getDeviceNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.control.DeviceReceiver | deviceReceiver | the notification callback |
Return | osid.control.DeviceNotificationSession | a DeviceNotificationSession | |
Errors | NULL_ARGUMENT | deviceReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDeviceNotification() is false | ||
Compliance | optional | This method must be implemented if supportsDeviceNotification()
is true. | |
Method | getDeviceNotificationSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.control.DeviceReceiver | deviceReceiver | the notification callback |
osid.id.Id | systemId | the Id of the System | |
Return | osid.control.DeviceNotificationSession | a DeviceNotificationSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | deviceReceiver or systemId is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDeviceNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDeviceNotification()
and supportsVisibleFederation() are true | |
Method | getDeviceSystemSession | ||
Description |
Gets the | ||
Return | osid.control.DeviceSystemSession | a DeviceSystemSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDeviceSystem() is false | ||
Compliance | optional | This method must be implemented if supportsDeviceSystem() is
true. | |
Method | getDeviceSystemAssignmentSession | ||
Description |
Gets the | ||
Return | osid.control.DeviceSystemAssignmentSession | a DeviceSystemAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDeviceSystemAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsDeviceSystemAssignment()
is true. | |
Method | getDeviceSmartSystemSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.DeviceSmartSystemSession | a DeviceSmartSystemSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDeviceSmartSystem() is false | ||
Compliance | optional | This method must be implemented if supportsDeviceSmartSystem()
is true. | |
Method | getControllerLookupSession | ||
Description |
Gets the | ||
Return | osid.control.ControllerLookupSession | a ControllerLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsControllerLookup() is false | ||
Compliance | optional | This method must be implemented if supportsControllerLookup()
is true. | |
Method | getControllerLookupSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.ControllerLookupSession | a ControllerLookupSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsControllerLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsControllerLookup()
and supportsVisibleFederation() are true | |
Method | getControllerQuerySession | ||
Description |
Gets the | ||
Return | osid.control.ControllerQuerySession | a ControllerQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsControllerQuery() is false | ||
Compliance | optional | This method must be implemented if supportsControllerQuery()
is true. | |
Method | getControllerQuerySessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.ControllerQuerySession | a ControllerQuerySession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsControllerQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsControllerQuery()
and supportsVisibleFederation() are true | |
Method | getControllerSearchSession | ||
Description |
Gets the | ||
Return | osid.control.ControllerSearchSession | a ControllerSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsControllerSearch() is false | ||
Compliance | optional | This method must be implemented if supportsControllerSearch()
is true. | |
Method | getControllerSearchSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.ControllerSearchSession | a ControllerSearchSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsControllerSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsControllerSearch()
and supportsVisibleFederation() are true | |
Method | getControllerAdminSession | ||
Description |
Gets the | ||
Return | osid.control.ControllerAdminSession | a ControllerAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsControllerAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsControllerAdmin()
is true. | |
Method | getControllerAdminSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.ControllerAdminSession | a ControllerAdminSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsControllerAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsControllerAdmin()
and supportsVisibleFederation() are true | |
Method | getControllerNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.control.ControllerReceiver | controllerReceiver | the notification callback |
Return | osid.control.ControllerNotificationSession | a ControllerNotificationSession | |
Errors | NULL_ARGUMENT | controllerReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsControllerNotification() is false | ||
Compliance | optional | This method must be implemented if supportsControllerNotification()
is true. | |
Method | getControllerNotificationSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.control.ControllerReceiver | controllerReceiver | the notification callback |
osid.id.Id | systemId | the Id of the System | |
Return | osid.control.ControllerNotificationSession | a ControllerNotificationSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | controllerReceiver or systemId is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsControllerNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsControllerNotification()
and supportsVisibleFederation() are true | |
Method | getControllerSystemSession | ||
Description |
Gets the | ||
Return | osid.control.ControllerSystemSession | a ControllerSystemSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsControllerSystem() is false | ||
Compliance | optional | This method must be implemented if supportsControllerSystem()
is true. | |
Method | getControllerSystemAssignmentSession | ||
Description |
Gets the | ||
Return | osid.control.ControllerSystemAssignmentSession | a ControllerSystemAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsControllerSystemAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsControllerSystemAssignment() is true. | |
Method | getControllerSmartSystemSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the system |
Return | osid.control.ControllerSmartSystemSession | a ControllerSmartSystemSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsControllerSmartSystem() is false | ||
Compliance | optional | This method must be implemented if supportsControllerSmartSystem()
is true. | |
Method | getInputLookupSession | ||
Description |
Gets the | ||
Return | osid.control.InputLookupSession | an InputLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInputLookup() is false | ||
Compliance | optional | This method must be implemented if supportsInputLookup() is
true. | |
Method | getInputLookupSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.InputLookupSession | an InputLookupSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInputLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsInputLookup() and
supportsVisibleFederation() are true | |
Method | getInputQuerySession | ||
Description |
Gets the | ||
Return | osid.control.InputQuerySession | an InputQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInputQuery() is false | ||
Compliance | optional | This method must be implemented if supportsInputQuery() is
true. | |
Method | getInputQuerySessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.InputQuerySession | an InputQuerySession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInputQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsInputQuery() and
supportsVisibleFederation() are true | |
Method | getInputSearchSession | ||
Description |
Gets the | ||
Return | osid.control.InputSearchSession | an InputSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInputSearch() is false | ||
Compliance | optional | This method must be implemented if supportsInputSearch() is
true. | |
Method | getInputSearchSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.InputSearchSession | an InputSearchSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInputSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsInputSearch() and
supportsVisibleFederation() are true | |
Method | getInputAdminSession | ||
Description |
Gets the | ||
Return | osid.control.InputAdminSession | an InputAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInputAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsInputAdmin() is
true. | |
Method | getInputAdminSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.InputAdminSession | an InputAdminSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInputAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsInputAdmin() and
supportsVisibleFederation() are true | |
Method | getInputNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.control.InputReceiver | inputReceiver | the notification callback |
Return | osid.control.InputNotificationSession | an InputNotificationSession | |
Errors | NULL_ARGUMENT | inputReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInputNotification() is false | ||
Compliance | optional | This method must be implemented if supportsInputNotification()
is true. | |
Method | getInputNotificationSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.control.InputReceiver | inputReceiver | the notification callback |
osid.id.Id | systemId | the Id of the System | |
Return | osid.control.InputNotificationSession | an InputNotificationSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | inputReceiver or systemId is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInputNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsInputNotification()
and supportsVisibleFederation() are true | |
Method | getInputSystemSession | ||
Description |
Gets the | ||
Return | osid.control.InputSystemSession | an InputSystemSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInputSystem() is false | ||
Compliance | optional | This method must be implemented if supportsInputSystem() is
true. | |
Method | getInputSystemAssignmentSession | ||
Description |
Gets the | ||
Return | osid.control.InputSystemAssignmentSession | an InputSystemAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInputSystemAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsInputSystemAssignment()
is true. | |
Method | getInputSmartSystemSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.InputSmartSystemSession | an InputSmartSystemSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInputSmartSystem() is false | ||
Compliance | optional | This method must be implemented if supportsInputSmartSystem()
is true. | |
Method | getSettingLookupSession | ||
Description |
Gets the | ||
Return | osid.control.SettingLookupSession | a SettingLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSettingLookup() is false | ||
Compliance | optional | This method must be implemented if supportsSettingLookup()
is true. | |
Method | getSettingLookupSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the system |
Return | osid.control.SettingLookupSession | a SettingLookupSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSettingLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSettingLookup()
and supportsVisibleFederation() are true | |
Method | getSettingQuerySession | ||
Description |
Gets the | ||
Return | osid.control.SettingQuerySession | a SettingQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSettingQuery() is false | ||
Compliance | optional | This method must be implemented if supportsSettingQuery() is
true. | |
Method | getSettingQuerySessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.SettingQuerySession | a SettingQuerySession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSettingQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsSettingQuery()
and supportsVisibleFederation() are true | |
Method | getSettingSearchSession | ||
Description |
Gets the | ||
Return | osid.control.SettingSearchSession | a SettingSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSettingSearch() is false | ||
Compliance | optional | This method must be implemented if supportsSettingSearch()
is true. | |
Method | getSettingSearchSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.SettingSearchSession | a SettingSearchSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSettingSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSettingSearch()
and supportsVisibleFederation() are true | |
Method | getSettingAdminSession | ||
Description |
Gets the | ||
Return | osid.control.SettingAdminSession | a SettingAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSettingAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsSettingAdmin() is
true. | |
Method | getSettingAdminSessionForInput | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the Dostributor |
Return | osid.control.SettingAdminSession | a SettingAdminSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSettingAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsSettingAdmin()
and supportsVisibleFederation() are true | |
Method | getSettingNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.control.SettingReceiver | settingReceiver | the notification callback |
Return | osid.control.SettingNotificationSession | a SettingNotificationSession | |
Errors | NULL_ARGUMENT | settingReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSettingNotification() is false | ||
Compliance | optional | This method must be implemented if supportsSettingNotification()
is true. | |
Method | getSettingNotificationSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.control.SettingReceiver | settingReceiver | the notification callback |
osid.id.Id | systemId | the Id of the System | |
Return | osid.control.SettingNotificationSession | a SettingNotificationSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | settingReceiver or systemId is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSettingNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSettingNotification()
and supportsVisibleFederation() are true | |
Method | getSettingSystemSession | ||
Description |
Gets the | ||
Return | osid.control.SettingSystemSession | a SettingSystemSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSettingSystem() is false | ||
Compliance | optional | This method must be implemented if supportsSettingSystem()
is true. | |
Method | getSettingSystemAssignmentSession | ||
Description |
Gets the | ||
Return | osid.control.SettingSystemAssignmentSession | a SettingSystemAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSettingSystemAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsSettingSystemAssignment()
is true. | |
Method | getSettingSmartSystemSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.SettingSmartSystemSession | a SettingSmartSystemSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSettingSmartSystem() is false | ||
Compliance | optional | This method must be implemented if supportsSettingSmartSystem()
is true. | |
Method | getSceneLookupSession | ||
Description |
Gets the | ||
Return | osid.control.SceneLookupSession | a SceneLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSceneLookup() is false | ||
Compliance | optional | This method must be implemented if supportsSceneLookup() is
true. | |
Method | getSceneLookupSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the system |
Return | osid.control.SceneLookupSession | a SceneLookupSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSceneLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsSceneLookup() and
supportsVisibleFederation() are true | |
Method | getSceneQuerySession | ||
Description |
Gets the | ||
Return | osid.control.SceneQuerySession | a SceneQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSceneQuery() is false | ||
Compliance | optional | This method must be implemented if supportsSceneQuery() is
true. | |
Method | getSceneQuerySessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.SceneQuerySession | a SceneQuerySession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSceneQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsSceneQuery() and
supportsVisibleFederation() are true | |
Method | getSceneSearchSession | ||
Description |
Gets the | ||
Return | osid.control.SceneSearchSession | a SceneSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSceneSearch() is false | ||
Compliance | optional | This method must be implemented if supportsSceneSearch() is
true. | |
Method | getSceneSearchSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.SceneSearchSession | a SceneSearchSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSceneSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsSceneSearch() and
supportsVisibleFederation() are true | |
Method | getSceneAdminSession | ||
Description |
Gets the | ||
Return | osid.control.SceneAdminSession | a SceneAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSceneAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsSceneAdmin() is
true. | |
Method | getSceneAdminSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the Dostributor |
Return | osid.control.SceneAdminSession | a SceneAdminSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSceneAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsSceneAdmin() and
supportsVisibleFederation() are true | |
Method | getSceneNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.control.SceneReceiver | sceneReceiver | the notification callback |
Return | osid.control.SceneNotificationSession | a SceneNotificationSession | |
Errors | NULL_ARGUMENT | sceneReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSceneNotification() is false | ||
Compliance | optional | This method must be implemented if supportsSceneNotification()
is true. | |
Method | getSceneNotificationSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.control.SceneReceiver | sceneReceiver | the notification callback |
osid.id.Id | systemId | the Id of the System | |
Return | osid.control.SceneNotificationSession | a SceneNotificationSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | sceneReceiver or systemId is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSceneNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSceneNotification()
and supportsVisibleFederation() are true | |
Method | getSceneSystemSession | ||
Description |
Gets the | ||
Return | osid.control.SceneSystemSession | a SceneSystemSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSceneSystem() is false | ||
Compliance | optional | This method must be implemented if supportsSceneSystem() is
true. | |
Method | getSceneSystemAssignmentSession | ||
Description |
Gets the | ||
Return | osid.control.SceneSystemAssignmentSession | a SceneSystemAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSceneSystemAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsSceneSystemAssignment()
is true. | |
Method | getSceneSmartSystemSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.SceneSmartSystemSession | a SceneSmartSystemSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSceneSmartSystem() is false | ||
Compliance | optional | This method must be implemented if supportsSceneSmartSystem()
is true. | |
Method | getTriggerLookupSession | ||
Description |
Gets the | ||
Return | osid.control.TriggerLookupSession | a TriggerLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTriggerLookup() is false | ||
Compliance | optional | This method must be implemented if supportsTriggerLookup()
is true. | |
Method | getTriggerLookupSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.TriggerLookupSession | a TriggerLookupSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTriggerLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsTriggerLookup()
and supportsVisibleFederation() are true | |
Method | getTriggerQuerySession | ||
Description |
Gets the | ||
Return | osid.control.TriggerQuerySession | a TriggerQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTriggerQuery() is false | ||
Compliance | optional | This method must be implemented if supportsTriggerQuery() is
true. | |
Method | getTriggerQuerySessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.TriggerQuerySession | a TriggerQuerySession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTriggerQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsTriggerQuery()
and supportsVisibleFederation() are true | |
Method | getTriggerSearchSession | ||
Description |
Gets the | ||
Return | osid.control.TriggerSearchSession | a TriggerSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTriggerSearch() is false | ||
Compliance | optional | This method must be implemented if supportsTriggerSearch()
is true. | |
Method | getTriggerSearchSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.TriggerSearchSession | a TriggerSearchSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTriggerSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsTriggerSearch()
and supportsVisibleFederation() are true | |
Method | getTriggerAdminSession | ||
Description |
Gets the | ||
Return | osid.control.TriggerAdminSession | a TriggerAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTriggerAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsTriggerAdmin() is
true. | |
Method | getTriggerAdminSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.TriggerAdminSession | a TriggerAdminSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTriggerAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsTriggerAdmin()
and supportsVisibleFederation() are true | |
Method | getTriggerNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.control.TriggerReceiver | triggerReceiver | the notification callback |
Return | osid.control.TriggerNotificationSession | a TriggerNotificationSession | |
Errors | NULL_ARGUMENT | triggerReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTriggerNotification() is false | ||
Compliance | optional | This method must be implemented if supportsTriggerNotification()
is true. | |
Method | getTriggerNotificationSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.control.TriggerReceiver | triggerReceiver | the notification callback |
osid.id.Id | systemId | the Id of the System | |
Return | osid.control.TriggerNotificationSession | a TriggerNotificationSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | triggerReceiver or systemId is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTriggerNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsTriggerNotification()
and supportsVisibleFederation() are true | |
Method | getTriggerSystemSession | ||
Description |
Gets the | ||
Return | osid.control.TriggerSystemSession | a TriggerSystemSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTriggerSystem() is false | ||
Compliance | optional | This method must be implemented if supportsTriggerSystem()
is true. | |
Method | getTriggerSystemAssignmentSession | ||
Description |
Gets the | ||
Return | osid.control.TriggerSystemAssignmentSession | a TriggerSystemAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTriggerSystemAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsTriggerSystemAssignment()
is true. | |
Method | getTriggerSmartSystemSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.TriggerSmartSystemSession | a TriggerSmartSystemSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTriggerSmartSystem() is false | ||
Compliance | optional | This method must be implemented if supportsTriggerSmartSystem()
is true. | |
Method | getActionGroupLookupSession | ||
Description |
Gets the | ||
Return | osid.control.ActionGroupLookupSession | an ActionGroupLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActionGroupLookup() is false | ||
Compliance | optional | This method must be implemented if supportsActionGroupLookup()
is true. | |
Method | getActionGroupLookupSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.ActionGroupLookupSession | an ActionGroupLookupSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActionGroupLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActionGroupLookup()
and supportsVisibleFederation() are true | |
Method | getActionGroupQuerySession | ||
Description |
Gets the | ||
Return | osid.control.ActionGroupQuerySession | an ActionGroupQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActionGroupQuery() is false | ||
Compliance | optional | This method must be implemented if supportsActionGroupQuery()
is true. | |
Method | getActionGroupQuerySessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.ActionGroupQuerySession | an ActionGroupQuerySession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActionGroupQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActionGroupQuery()
and supportsVisibleFederation() are true | |
Method | getActionGroupSearchSession | ||
Description |
Gets the | ||
Return | osid.control.ActionGroupSearchSession | an ActionGroupSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActionGroupSearch() is false | ||
Compliance | optional | This method must be implemented if supportsActionGroupSearch()
is true. | |
Method | getActionGroupSearchSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.ActionGroupSearchSession | an ActionGroupSearchSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActionGroupSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActionGroupSearch()
and supportsVisibleFederation() are true | |
Method | getActionGroupAdminSession | ||
Description |
Gets the | ||
Return | osid.control.ActionGroupAdminSession | an ActionGroupAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActionGroupAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsActionGroupAdmin()
is true. | |
Method | getActionGroupAdminSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.ActionGroupAdminSession | an ActionGroupAdminSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActionGroupAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActionGroupAdmin()
and supportsVisibleFederation() are true | |
Method | getActionGroupNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.control.ActionGroupReceiver | actionGroupReceiver | the notification callback |
Return | osid.control.ActionGroupNotificationSession | an ActionGroupNotificationSession | |
Errors | NULL_ARGUMENT | actionGroupReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActionGroupNotification() is false | ||
Compliance | optional | This method must be implemented if supportsActionGroupNotification()
is true. | |
Method | getActionGroupNotificationSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.control.ActionGroupReceiver | actionGroupReceiver | the notification callback |
osid.id.Id | systemId | the Id of the System | |
Return | osid.control.ActionGroupNotificationSession | an ActionGroupNotificationSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | actionGroupReceiver or systemId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActionGroupNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActionGroupNotification()
and supportsVisibleFederation() are true | |
Method | getActionGroupSystemSession | ||
Description |
Gets the | ||
Return | osid.control.ActionGroupSystemSession | an ActionGroupSystemSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActionGroupSystem() is false | ||
Compliance | optional | This method must be implemented if supportsActionGroupSystem()
is true. | |
Method | getActionGroupSystemAssignmentSession | ||
Description |
Gets the | ||
Return | osid.control.ActionGroupSystemAssignmentSession | an ActionGroupSystemAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActionGroupSystemAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsActionGroupSystemAssignment() is true. | |
Method | getActionGroupSmartSystemSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.ActionGroupSmartSystemSession | an ActionGroupSmartSystemSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActionGroupSmartSystem() is false | ||
Compliance | optional | This method must be implemented if supportsActionGroupSmartSystem()
is true. | |
Method | getSystemLookupSession | ||
Description |
Gets the | ||
Return | osid.control.SystemLookupSession | a SystemLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSystemLookup() is false | ||
Compliance | optional | This method must be implemented if supportsSystemLookup() is
true. | |
Method | getSystemQuerySession | ||
Description |
Gets the | ||
Return | osid.control.SystemQuerySession | a SystemQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSystemQuery() is false | ||
Compliance | optional | This method must be implemented if supportsSystemQuery() is
true. | |
Method | getSystemSearchSession | ||
Description |
Gets the | ||
Return | osid.control.SystemSearchSession | a SystemSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSystemSearch() is false | ||
Compliance | optional | This method must be implemented if supportsSystemSearch() is
true. | |
Method | getSystemAdminSession | ||
Description |
Gets the | ||
Return | osid.control.SystemAdminSession | a SystemAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSystemAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsSystemAdmin() is
true. | |
Method | getSystemNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.control.SystemReceiver | systemReceiver | the notification callback |
Return | osid.control.SystemNotificationSession | a SystemNotificationSession | |
Errors | NULL_ARGUMENT | systemReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSystemNotification() is false | ||
Compliance | optional | This method must be implemented if supportsSystemNotification()
is true. | |
Method | getSystemHierarchySession | ||
Description |
Gets the | ||
Return | osid.control.SystemHierarchySession | a SystemHierarchySession for systems | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSystemHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsSystemHierarchy()
is true. | |
Method | getSystemHierarchyDesignSession | ||
Description |
Gets the | ||
Return | osid.control.SystemHierarchyDesignSession | a HierarchyDesignSession for systems | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSystemHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if supportsSystemHierarchyDesign()
is true. | |
Method | getControlBatchManager | ||
Description |
Gets the | ||
Return | osid.control.batch.ControlBatchManager | a ControlBatchManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsControlBatch() is false | ||
Compliance | optional | This method must be implemented if supportsControlBatch() is
true. | |
Method | getControlRulesManager | ||
Description |
Gets the | ||
Return | osid.control.rules.ControlRulesManager | a ControlRulesManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsControlRules() is false | ||
Compliance | optional | This method must be implemented if supportsControlRules() is
true. |