Interface | osid.control.rules.ControlRulesManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.control.rules.ControlRulesProfile | |||
Description |
The control rules manager provides access to control rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
Method | getDeviceEnablerLookupSession | ||
Description |
Gets the | ||
Return | osid.control.rules.DeviceEnablerLookupSession | a DeviceEnablerLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDeviceEnablerLookup() is false | ||
Compliance | optional | This method must be implemented if supportsDeviceEnablerLookup()
is true. | |
Method | getDeviceEnablerLookupSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.DeviceEnablerLookupSession | a DeviceEnablerLookupSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDeviceEnablerLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDeviceEnablerLookup()
and supportsVisibleFederation() are true.
| |
Method | getDeviceEnablerQuerySession | ||
Description |
Gets the | ||
Return | osid.control.rules.DeviceEnablerQuerySession | a DeviceEnablerQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDeviceEnablerQuery() is false | ||
Compliance | optional | This method must be implemented if supportsDeviceEnablerQuery()
is true. | |
Method | getDeviceEnablerQuerySessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.DeviceEnablerQuerySession | a DeviceEnablerQuerySession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDeviceEnablerQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDeviceEnablerQuery()
and supportsVisibleFederation() are true.
| |
Method | getDeviceEnablerSearchSession | ||
Description |
Gets the | ||
Return | osid.control.rules.DeviceEnablerSearchSession | a DeviceEnablerSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDeviceEnablerSearch() is false | ||
Compliance | optional | This method must be implemented if supportsDeviceEnablerSearch()
is true. | |
Method | getDeviceEnablerSearchSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.DeviceEnablerSearchSession | a DeviceEnablerSearchSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDeviceEnablerSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDeviceEnablerSearch()
and supportsVisibleFederation() are true.
| |
Method | getDeviceEnablerAdminSession | ||
Description |
Gets the | ||
Return | osid.control.rules.DeviceEnablerAdminSession | a DeviceEnablerAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDeviceEnablerAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsDeviceEnablerAdmin()
is true. | |
Method | getDeviceEnablerAdminSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.DeviceEnablerAdminSession | a DeviceEnablerAdminSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDeviceEnablerAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDeviceEnablerAdmin()
and supportsVisibleFederation() are true.
| |
Method | getDeviceEnablerNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.control.rules.DeviceEnablerReceiver | deviceEnablerReceiver | the notification callback |
Return | osid.control.rules.DeviceEnablerNotificationSession | a DeviceEnablerNotificationSession | |
Errors | NULL_ARGUMENT | deviceEnablerReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDeviceEnablerNotification() is false | ||
Compliance | optional | This method must be implemented if
supportsDeviceEnablerNotification() is true. | |
Method | getDeviceEnablerNotificationSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.control.rules.DeviceEnablerReceiver | deviceEnablerReceiver | the notification callback |
osid.id.Id | systemId | the Id of the System | |
Return | osid.control.rules.DeviceEnablerNotificationSession | a DeviceEnablerNotificationSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | deviceEnablerReceiver or systemId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDeviceEnablerNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsDeviceEnablerNotification() and
supportsVisibleFederation() are true. | |
Method | getDeviceEnablerSystemSession | ||
Description |
Gets the | ||
Return | osid.control.rules.DeviceEnablerSystemSession | a DeviceEnablerSystemSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDeviceEnablerSystem() is false | ||
Compliance | optional | This method must be implemented if supportsDeviceEnablerSystem()
is true. | |
Method | getDeviceEnablerSystemAssignmentSession | ||
Description |
Gets the | ||
Return | osid.control.rules.DeviceEnablerSystemAssignmentSession | a DeviceEnablerSystemAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDeviceEnablerSystemAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsDeviceEnablerSystemAssignment() is true. | |
Method | getDeviceEnablerSmartSystemSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.DeviceEnablerSmartSystemSession | a DeviceEnablerSmartSystemSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDeviceEnablerSmartSystem() is false | ||
Compliance | optional | This method must be implemented if
supportsDeviceEnablerSmartSystem() is true. | |
Method | getDeviceEnablerRuleLookupSession | ||
Description |
Gets the | ||
Return | osid.control.rules.DeviceEnablerRuleLookupSession | a DeviceEnablerRuleLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDeviceEnablerRuleLookup() is false | ||
Compliance | optional | This method must be implemented if supportsDeviceEnablerRuleLookup()
is true. | |
Method | getDeviceEnablerRuleLookupSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.DeviceEnablerRuleLookupSession | a DeviceEnablerRuleLookupSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDeviceEnablerRuleLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDeviceEnablerRuleLookup()
and supportsVisibleFederation() are true.
| |
Method | getDeviceEnablerRuleApplicationSession | ||
Description |
Gets the | ||
Return | osid.control.rules.DeviceEnablerRuleApplicationSession | a DeviceEnablerRuleApplicationSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDeviceEnablerRuleApplication() is false
| ||
Compliance | optional | This method must be implemented if
supportsDeviceEnablerRuleApplication() is true. | |
Method | getDeviceEnablerRuleApplicationSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.DeviceEnablerRuleApplicationSession | a DeviceEnablerRuleApplicationSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDeviceEnablerRuleApplication() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsDeviceEnablerRuleApplication() and
supportsVisibleFederation() are true. | |
Method | getInputEnablerLookupSession | ||
Description |
Gets the | ||
Return | osid.control.rules.InputEnablerLookupSession | an InputEnablerLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInputEnablerLookup() is false | ||
Compliance | optional | This method must be implemented if supportsInputEnablerLookup()
is true. | |
Method | getInputEnablerLookupSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.InputEnablerLookupSession | an InputEnablerLookupSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInputEnablerLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsInputEnablerLookup()
and supportsVisibleFederation() are true.
| |
Method | getInputEnablerQuerySession | ||
Description |
Gets the | ||
Return | osid.control.rules.InputEnablerQuerySession | an InputEnablerQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInputEnablerQuery() is false | ||
Compliance | optional | This method must be implemented if supportsInputEnablerQuery()
is true. | |
Method | getInputEnablerQuerySessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.InputEnablerQuerySession | an InputEnablerQuerySession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInputEnablerQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsInputEnablerQuery()
and supportsVisibleFederation() are true.
| |
Method | getInputEnablerSearchSession | ||
Description |
Gets the | ||
Return | osid.control.rules.InputEnablerSearchSession | an InputEnablerSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInputEnablerSearch() is false | ||
Compliance | optional | This method must be implemented if supportsInputEnablerSearch()
is true. | |
Method | getInputEnablerSearchSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.InputEnablerSearchSession | an InputEnablerSearchSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInputEnablerSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsInputEnablerSearch()
and supportsVisibleFederation() are true.
| |
Method | getInputEnablerAdminSession | ||
Description |
Gets the | ||
Return | osid.control.rules.InputEnablerAdminSession | an InputEnablerAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInputEnablerAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsInputEnablerAdmin()
is true. | |
Method | getInputEnablerAdminSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.InputEnablerAdminSession | an InputEnablerAdminSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInputEnablerAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsInputEnablerAdmin()
and supportsVisibleFederation() are true.
| |
Method | getInputEnablerNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.control.rules.InputEnablerReceiver | inputEnablerReceiver | the notification callback |
Return | osid.control.rules.InputEnablerNotificationSession | an InputEnablerNotificationSession | |
Errors | NULL_ARGUMENT | inputEnablerReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInputEnablerNotification() is false | ||
Compliance | optional | This method must be implemented if
supportsInputEnablerNotification() is true. | |
Method | getInputEnablerNotificationSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.control.rules.InputEnablerReceiver | inputEnablerReceiver | the notification callback |
osid.id.Id | systemId | the Id of the System | |
Return | osid.control.rules.InputEnablerNotificationSession | an InputEnablerNotificationSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | inputEnablerReceiver or systemId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInputEnablerNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsInputEnablerNotification() and
supportsVisibleFederation() are true. | |
Method | getInputEnablerSystemSession | ||
Description |
Gets the | ||
Return | osid.control.rules.InputEnablerSystemSession | an InputEnablerSystemSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInputEnablerSystem() is false | ||
Compliance | optional | This method must be implemented if supportsInputEnablerSystem()
is true. | |
Method | getInputEnablerSystemAssignmentSession | ||
Description |
Gets the | ||
Return | osid.control.rules.InputEnablerSystemAssignmentSession | an InputEnablerSystemAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInputEnablerSystemAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsInputEnablerSystemAssignment() is true. | |
Method | getInputEnablerSmartSystemSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.InputEnablerSmartSystemSession | an InputEnablerSmartSystemSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInputEnablerSmartSystem() is false | ||
Compliance | optional | This method must be implemented if supportsInputEnablerSmartSystem()
is true. | |
Method | getInputEnablerRuleLookupSession | ||
Description |
Gets the | ||
Return | osid.control.rules.InputEnablerRuleLookupSession | an InputEnablerRuleLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInputEnablerRuleLookup() is false | ||
Compliance | optional | This method must be implemented if supportsInputEnablerRuleLookup()
is true. | |
Method | getInputEnablerRuleLookupSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.InputEnablerRuleLookupSession | an InputEnablerRuleLookupSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInputEnablerRuleLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsInputEnablerRuleLookup()
and supportsVisibleFederation() are true.
| |
Method | getInputEnablerRuleApplicationSession | ||
Description |
Gets the | ||
Return | osid.control.rules.InputEnablerRuleApplicationSession | an InputEnablerRuleApplicationSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInputEnablerRuleApplication() is false
| ||
Compliance | optional | This method must be implemented if
supportsInputEnablerRuleApplication() is true. | |
Method | getInputEnablerRuleApplicationSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.InputEnablerRuleApplicationSession | an InputEnablerRuleApplicationSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInputEnablerRuleApplication() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsInputEnablerRuleApplication() and
supportsVisibleFederation() are true. | |
Method | getTriggerEnablerLookupSession | ||
Description |
Gets the | ||
Return | osid.control.rules.TriggerEnablerLookupSession | a TriggerEnablerLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTriggerEnablerLookup() is false | ||
Compliance | optional | This method must be implemented if supportsTriggerEnablerLookup()
is true. | |
Method | getTriggerEnablerLookupSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.TriggerEnablerLookupSession | a TriggerEnablerLookupSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTriggerEnablerLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsTriggerEnablerLookup()
and supportsVisibleFederation() are true.
| |
Method | getTriggerEnablerQuerySession | ||
Description |
Gets the | ||
Return | osid.control.rules.TriggerEnablerQuerySession | a TriggerEnablerQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTriggerEnablerQuery() is false | ||
Compliance | optional | This method must be implemented if supportsTriggerEnablerQuery()
is true. | |
Method | getTriggerEnablerQuerySessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.TriggerEnablerQuerySession | a TriggerEnablerQuerySession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTriggerEnablerQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsTriggerEnablerQuery()
and supportsVisibleFederation() are true.
| |
Method | getTriggerEnablerSearchSession | ||
Description |
Gets the | ||
Return | osid.control.rules.TriggerEnablerSearchSession | a TriggerEnablerSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTriggerEnablerSearch() is false | ||
Compliance | optional | This method must be implemented if supportsTriggerEnablerSearch()
is true. | |
Method | getTriggerEnablerSearchSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.TriggerEnablerSearchSession | a TriggerEnablerSearchSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTriggerEnablerSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsTriggerEnablerSearch()
and supportsVisibleFederation() are true.
| |
Method | getTriggerEnablerAdminSession | ||
Description |
Gets the | ||
Return | osid.control.rules.TriggerEnablerAdminSession | a TriggerEnablerAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTriggerEnablerAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsTriggerEnablerAdmin()
is true. | |
Method | getTriggerEnablerAdminSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.TriggerEnablerAdminSession | a TriggerEnablerAdminSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTriggerEnablerAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsTriggerEnablerAdmin()
and supportsVisibleFederation() are true.
| |
Method | getTriggerEnablerNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.control.rules.TriggerEnablerReceiver | triggerEnablerReceiver | the notification callback |
Return | osid.control.rules.TriggerEnablerNotificationSession | a TriggerEnablerNotificationSession | |
Errors | NULL_ARGUMENT | triggerEnablerReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTriggerEnablerNotification() is false | ||
Compliance | optional | This method must be implemented if
supportsTriggerEnablerNotification() is true. | |
Method | getTriggerEnablerNotificationSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.control.rules.TriggerEnablerReceiver | triggerEnablerReceiver | the notification callback |
osid.id.Id | systemId | the Id of the System | |
Return | osid.control.rules.TriggerEnablerNotificationSession | a TriggerEnablerNotificationSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | triggerEnablerReceiver or systemId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTriggerEnablerNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsTriggerEnablerNotification() and
supportsVisibleFederation() are true. | |
Method | getTriggerEnablerSystemSession | ||
Description |
Gets the | ||
Return | osid.control.rules.TriggerEnablerSystemSession | a TriggerEnablerSystemSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTriggerEnablerSystem() is false | ||
Compliance | optional | This method must be implemented if supportsTriggerEnablerSystem()
is true. | |
Method | getTriggerEnablerSystemAssignmentSession | ||
Description |
Gets the | ||
Return | osid.control.rules.TriggerEnablerSystemAssignmentSession | a TriggerEnablerSystemAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTriggerEnablerSystemAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsTriggerEnablerSystemAssignment() is true. | |
Method | getTriggerEnablerSmartSystemSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.TriggerEnablerSmartSystemSession | a TriggerEnablerSmartSystemSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTriggerEnablerSmartSystem() is false | ||
Compliance | optional | This method must be implemented if
supportsTriggerEnablerSmartSystem() is true. | |
Method | getTriggerEnablerRuleLookupSession | ||
Description |
Gets the | ||
Return | osid.control.rules.TriggerEnablerRuleLookupSession | a TriggerEnablerRuleLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTriggerEnablerRuleLookup() is false | ||
Compliance | optional | This method must be implemented if
supportsTriggerEnablerRuleLookup() is true. | |
Method | getTriggerEnablerRuleLookupSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.TriggerEnablerRuleLookupSession | a TriggerEnablerRuleLookupSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTriggerEnablerRuleLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsTriggerEnablerRuleLookup() and
supportsVisibleFederation() are true. | |
Method | getTriggerEnablerRuleApplicationSession | ||
Description |
Gets the | ||
Return | osid.control.rules.TriggerEnablerRuleApplicationSession | a TriggerEnablerRuleApplicationSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTriggerEnablerRuleApplication() is false
| ||
Compliance | optional | This method must be implemented if
supportsTriggerEnablerRuleApplication() is true. | |
Method | getTriggerEnablerRuleApplicationSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.TriggerEnablerRuleApplicationSession | a TriggerEnablerRuleApplicationSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTriggerEnablerRuleApplication() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsTriggerEnablerRuleApplication() and
supportsVisibleFederation() are true. | |
Method | getActionEnablerLookupSession | ||
Description |
Gets the | ||
Return | osid.control.rules.ActionEnablerLookupSession | an ActionEnablerLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActionEnablerLookup() is false | ||
Compliance | optional | This method must be implemented if supportsActionEnablerLookup()
is true. | |
Method | getActionEnablerLookupSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.ActionEnablerLookupSession | an ActionEnablerLookupSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActionEnablerLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActionEnablerLookup()
and supportsVisibleFederation() are true.
| |
Method | getActionEnablerQuerySession | ||
Description |
Gets the | ||
Return | osid.control.rules.ActionEnablerQuerySession | an ActionEnablerQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActionEnablerQuery() is false | ||
Compliance | optional | This method must be implemented if supportsActionEnablerQuery()
is true. | |
Method | getActionEnablerQuerySessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.ActionEnablerQuerySession | an ActionEnablerQuerySession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActionEnablerQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActionEnablerQuery()
and supportsVisibleFederation() are true.
| |
Method | getActionEnablerSearchSession | ||
Description |
Gets the | ||
Return | osid.control.rules.ActionEnablerSearchSession | an ActionEnablerSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActionEnablerSearch() is false | ||
Compliance | optional | This method must be implemented if supportsActionEnablerSearch()
is true. | |
Method | getActionEnablerSearchSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.ActionEnablerSearchSession | an ActionEnablerSearchSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActionEnablerSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActionEnablerSearch()
and supportsVisibleFederation() are true.
| |
Method | getActionEnablerAdminSession | ||
Description |
Gets the | ||
Return | osid.control.rules.ActionEnablerAdminSession | an ActionEnablerAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActionEnablerAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsActionEnablerAdmin()
is true. | |
Method | getActionEnablerAdminSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.ActionEnablerAdminSession | an ActionEnablerAdminSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActionEnablerAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActionEnablerAdmin()
and supportsVisibleFederation() are true.
| |
Method | getActionEnablerNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.control.rules.ActionEnablerReceiver | actionEnablerReceiver | the notification callback |
Return | osid.control.rules.ActionEnablerNotificationSession | an ActionEnablerNotificationSession | |
Errors | NULL_ARGUMENT | actionEnablerReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActionEnablerNotification() is false | ||
Compliance | optional | This method must be implemented if
supportsActionEnablerNotification() is true. | |
Method | getActionEnablerNotificationSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.control.rules.ActionEnablerReceiver | actionEnablerReceiver | the notification callback |
osid.id.Id | systemId | the Id of the System | |
Return | osid.control.rules.ActionEnablerNotificationSession | an ActionEnablerNotificationSession | |
Errors | NOT_FOUND | no system found by the given Id | |
NULL_ARGUMENT | actionEnablerReceiver or systemId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActionEnablerNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsActionEnablerNotification() and
supportsVisibleFederation() are true. | |
Method | getActionEnablerSystemSession | ||
Description |
Gets the | ||
Return | osid.control.rules.ActionEnablerSystemSession | an ActionEnablerSystemSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActionEnablerSystem() is false | ||
Compliance | optional | This method must be implemented if supportsActionEnablerSystem()
is true. | |
Method | getActionEnablerSystemAssignmentSession | ||
Description |
Gets the | ||
Return | osid.control.rules.ActionEnablerSystemAssignmentSession | an ActionEnablerSystemAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActionEnablerSystemAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsActionEnablerSystemAssignment() is true. | |
Method | getActionEnablerSmartSystemSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.ActionEnablerSmartSystemSession | an ActionEnablerSmartSystemSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActionEnablerSmartSystem() is false | ||
Compliance | optional | This method must be implemented if
supportsActionEnablerSmartSystem() is true. | |
Method | getActionEnablerRuleLookupSession | ||
Description |
Gets the | ||
Return | osid.control.rules.ActionEnablerRuleLookupSession | an ActionEnablerRuleLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActionEnablerRuleLookup() is false | ||
Compliance | optional | This method must be implemented if supportsActionEnablerRuleLookup()
is true. | |
Method | getActionEnablerRuleLookupSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.ActionEnablerRuleLookupSession | an ActionEnablerRuleLookupSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActionEnablerRuleLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActionEnablerRuleLookup()
and supportsVisibleFederation() are true.
| |
Method | getActionEnablerRuleApplicationSession | ||
Description |
Gets the | ||
Return | osid.control.rules.ActionEnablerRuleApplicationSession | an ActionEnablerRuleApplicationSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActionEnablerRuleApplication() is false
| ||
Compliance | optional | This method must be implemented if
supportsActionEnablerRuleApplication() is true. | |
Method | getActionEnablerRuleApplicationSessionForSystem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.control.rules.ActionEnablerRuleApplicationSession | an ActionEnablerRuleApplicationSession | |
Errors | NOT_FOUND | no System found by the given Id | |
NULL_ARGUMENT | systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActionEnablerRuleApplication() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsActionEnablerRuleApplication() and
supportsVisibleFederation() are true. |