OSID Logo
OSID Specifications
control rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.rules.ControlRulesManager
Implementsosid.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:

  • DeviceEnablerLookupSession: a session to retrieve device enablers
  • DeviceEnablerQuerySession: a session to query for device enablers
  • DeviceEnablerSearchSession: a session to search for device enablers
  • DeviceEnablerAdminSession: a session to create and delete device enablers
  • DeviceEnablerNotificationSession: a session to receive notifications pertaining to device enabler changes
  • DeviceEnablerSystemSession: a session to look up device enabler system mappings
  • DeviceEnablerSystemAssignmentSession: a session to manage device enabler to system mappings
  • DeviceEnablerSmartSystemSession: a session to manage dynamic systems of device enablers
  • DeviceEnablerRuleLookupSession: a session to look up device enabler mappings
  • DeviceEnablerRuleApplicationSession: a session to apply device enablers
  • InputEnablerLookupSession: a session to retrieve input enablers
  • InputEnablerQuerySession: a session to query for input enablers
  • InputEnablerSearchSession: a session to search for input enablers
  • InputEnablerAdminSession: a session to create and delete input enablers
  • InputEnablerNotificationSession: a session to receive notifications pertaining to input enabler changes
  • InputEnablerSystemSession: a session to look up input enabler system mappings
  • InputEnablerSystemAssignmentSession: a session to manage input enabler to system mappings
  • InputEnablerSmartSystemSession: a session to manage dynamic systems of input enablers
  • InputEnablerRuleLookupSession: a session to look up input enabler mappings
  • InputEnablerRuleApplicationSession: a session to apply input enablers
  • TriggerEnablerLookupSession: a session to retrieve trigger enablers
  • TriggerEnablerQuerySession: a session to query for trigger enablers
  • TriggerEnablerSearchSession: a session to search for trigger enablers
  • TriggerEnablerAdminSession: a session to create and delete trigger enablers
  • TriggerEnablerNotificationSession: a session to receive notifications pertaining to trigger enabler changes
  • TriggerEnablerSystemSession: a session to look up trigger enabler system mappings
  • TriggerEnablerSystemAssignmentSession: a session to manage trigger enabler to system mappings
  • TriggerEnablerSmartSystemSession: a session to manage dynamic systems of trigger enablers
  • TriggerEnableRuleLookupSession: a session to look up trigger enabler mappings
  • TriggerEnablerRuleApplicationSession: a session to apply trigger enablers
  • ActionEnablerLookupSession: a session to retrieve action enablers
  • ActionEnablerQuerySession: a session to query for action enablers
  • ActionEnablerSearchSession: a session to search for action enablers
  • ActionEnablerAdminSession: a session to create and delete action enablers
  • ActionEnablerNotificationSession: a session to receive notifications pertaining to action enabler changes
  • ActionEnablerSystemSession: a session to look up action enabler system mappings
  • ActionEnablerSystemAssignmentSession: a session to manage action enabler to system mappings
  • ActionEnablerSmartSystemSession: a session to manage dynamic systems of action enablers
  • ActionEnableRuleLookupSession: a session to look up action enabler mappings
  • ActionEnablerRuleApplicationSession: a session to apply action enablers
MethodgetDeviceEnablerLookupSession
Description

Gets the OsidSession associated with the device enabler lookup service.

Returnosid.control.rules.DeviceEnablerLookupSessiona DeviceEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsDeviceEnablerLookup() is true.
MethodgetDeviceEnablerLookupSessionForSystem
Description

Gets the OsidSession associated with the device enabler lookup service for the given system.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.DeviceEnablerLookupSessiona DeviceEnablerLookupSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDeviceEnablerLookup() and supportsVisibleFederation() are true.
MethodgetDeviceEnablerQuerySession
Description

Gets the OsidSession associated with the device enabler query service.

Returnosid.control.rules.DeviceEnablerQuerySessiona DeviceEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsDeviceEnablerQuery() is true.
MethodgetDeviceEnablerQuerySessionForSystem
Description

Gets the OsidSession associated with the device enabler query service for the given System.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.DeviceEnablerQuerySessiona DeviceEnablerQuerySession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDeviceEnablerQuery() and supportsVisibleFederation() are true.
MethodgetDeviceEnablerSearchSession
Description

Gets the OsidSession associated with the device enabler search service.

Returnosid.control.rules.DeviceEnablerSearchSessiona DeviceEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsDeviceEnablerSearch() is true.
MethodgetDeviceEnablerSearchSessionForSystem
Description

Gets the OsidSession associated with the device enablers earch service for the given system.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.DeviceEnablerSearchSessiona DeviceEnablerSearchSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDeviceEnablerSearch() and supportsVisibleFederation() are true.
MethodgetDeviceEnablerAdminSession
Description

Gets the OsidSession associated with the device enabler administration service.

Returnosid.control.rules.DeviceEnablerAdminSessiona DeviceEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsDeviceEnablerAdmin() is true.
MethodgetDeviceEnablerAdminSessionForSystem
Description

Gets the OsidSession associated with the device enabler administration service for the given system.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.DeviceEnablerAdminSessiona DeviceEnablerAdminSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDeviceEnablerAdmin() and supportsVisibleFederation() are true.
MethodgetDeviceEnablerNotificationSession
Description

Gets the OsidSession associated with the device enabler notification service.

Parametersosid.control.rules.DeviceEnablerReceiverdeviceEnablerReceiverthe notification callback
Returnosid.control.rules.DeviceEnablerNotificationSessiona DeviceEnablerNotificationSession
ErrorsNULL_ARGUMENT deviceEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsDeviceEnablerNotification() is true.
MethodgetDeviceEnablerNotificationSessionForSystem
Description

Gets the OsidSession associated with the device enabler notification service for the given system.

Parametersosid.control.rules.DeviceEnablerReceiverdeviceEnablerReceiverthe notification callback
osid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.DeviceEnablerNotificationSessiona DeviceEnablerNotificationSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT deviceEnablerReceiver or systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDeviceEnablerNotification() and supportsVisibleFederation() are true.
MethodgetDeviceEnablerSystemSession
Description

Gets the OsidSession to lookup device enabler/system mappings for device enablers.

Returnosid.control.rules.DeviceEnablerSystemSessiona DeviceEnablerSystemSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceEnablerSystem() is false
ComplianceoptionalThis method must be implemented if supportsDeviceEnablerSystem() is true.
MethodgetDeviceEnablerSystemAssignmentSession
Description

Gets the OsidSession associated with assigning device enablers to systems.

Returnosid.control.rules.DeviceEnablerSystemAssignmentSessiona DeviceEnablerSystemAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceEnablerSystemAssignment() is false
ComplianceoptionalThis method must be implemented if supportsDeviceEnablerSystemAssignment() is true.
MethodgetDeviceEnablerSmartSystemSession
Description

Gets the OsidSession to manage device enabler smart systems.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.DeviceEnablerSmartSystemSessiona DeviceEnablerSmartSystemSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceEnablerSmartSystem() is false
ComplianceoptionalThis method must be implemented if supportsDeviceEnablerSmartSystem() is true.
MethodgetDeviceEnablerRuleLookupSession
Description

Gets the OsidSession associated with the device enabler mapping lookup service.

Returnosid.control.rules.DeviceEnablerRuleLookupSessiona DeviceEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsDeviceEnablerRuleLookup() is true.
MethodgetDeviceEnablerRuleLookupSessionForSystem
Description

Gets the OsidSession associated with the device enabler mapping lookup service for the given system.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.DeviceEnablerRuleLookupSessiona DeviceEnablerRuleLookupSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDeviceEnablerRuleLookup() and supportsVisibleFederation() are true.
MethodgetDeviceEnablerRuleApplicationSession
Description

Gets the OsidSession associated with the device enabler assignment service.

Returnosid.control.rules.DeviceEnablerRuleApplicationSessiona DeviceEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsDeviceEnablerRuleApplication() is true.
MethodgetDeviceEnablerRuleApplicationSessionForSystem
Description

Gets the OsidSession associated with the device enabler assignment service for the given system.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.DeviceEnablerRuleApplicationSessiona DeviceEnablerRuleApplicationSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDeviceEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDeviceEnablerRuleApplication() and supportsVisibleFederation() are true.
MethodgetInputEnablerLookupSession
Description

Gets the OsidSession associated with the input enabler lookup service.

Returnosid.control.rules.InputEnablerLookupSessionan InputEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsInputEnablerLookup() is true.
MethodgetInputEnablerLookupSessionForSystem
Description

Gets the OsidSession associated with the input enabler lookup service for the given system.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.InputEnablerLookupSessionan InputEnablerLookupSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInputEnablerLookup() and supportsVisibleFederation() are true.
MethodgetInputEnablerQuerySession
Description

Gets the OsidSession associated with the input enabler query service.

Returnosid.control.rules.InputEnablerQuerySessionan InputEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsInputEnablerQuery() is true.
MethodgetInputEnablerQuerySessionForSystem
Description

Gets the OsidSession associated with the input enabler query service for the given system.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.InputEnablerQuerySessionan InputEnablerQuerySession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInputEnablerQuery() and supportsVisibleFederation() are true.
MethodgetInputEnablerSearchSession
Description

Gets the OsidSession associated with the input enabler search service.

Returnosid.control.rules.InputEnablerSearchSessionan InputEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsInputEnablerSearch() is true.
MethodgetInputEnablerSearchSessionForSystem
Description

Gets the OsidSession associated with the input enablers earch service for the given system.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.InputEnablerSearchSessionan InputEnablerSearchSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInputEnablerSearch() and supportsVisibleFederation() are true.
MethodgetInputEnablerAdminSession
Description

Gets the OsidSession associated with the input enabler administration service.

Returnosid.control.rules.InputEnablerAdminSessionan InputEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsInputEnablerAdmin() is true.
MethodgetInputEnablerAdminSessionForSystem
Description

Gets the OsidSession associated with the input enabler administration service for the given system.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.InputEnablerAdminSessionan InputEnablerAdminSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInputEnablerAdmin() and supportsVisibleFederation() are true.
MethodgetInputEnablerNotificationSession
Description

Gets the OsidSession associated with the input enabler notification service.

Parametersosid.control.rules.InputEnablerReceiverinputEnablerReceiverthe notification callback
Returnosid.control.rules.InputEnablerNotificationSessionan InputEnablerNotificationSession
ErrorsNULL_ARGUMENT inputEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsInputEnablerNotification() is true.
MethodgetInputEnablerNotificationSessionForSystem
Description

Gets the OsidSession associated with the input enabler notification service for the given system.

Parametersosid.control.rules.InputEnablerReceiverinputEnablerReceiverthe notification callback
osid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.InputEnablerNotificationSessionan InputEnablerNotificationSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT inputEnablerReceiver or systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInputEnablerNotification() and supportsVisibleFederation() are true.
MethodgetInputEnablerSystemSession
Description

Gets the OsidSession to lookup input enabler/system mappings for input enablers.

Returnosid.control.rules.InputEnablerSystemSessionan InputEnablerSystemSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputEnablerSystem() is false
ComplianceoptionalThis method must be implemented if supportsInputEnablerSystem() is true.
MethodgetInputEnablerSystemAssignmentSession
Description

Gets the OsidSession associated with assigning input enablers to systems.

Returnosid.control.rules.InputEnablerSystemAssignmentSessionan InputEnablerSystemAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputEnablerSystemAssignment() is false
ComplianceoptionalThis method must be implemented if supportsInputEnablerSystemAssignment() is true.
MethodgetInputEnablerSmartSystemSession
Description

Gets the OsidSession to manage input enabler smart systems.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.InputEnablerSmartSystemSessionan InputEnablerSmartSystemSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputEnablerSmartSystem() is false
ComplianceoptionalThis method must be implemented if supportsInputEnablerSmartSystem() is true.
MethodgetInputEnablerRuleLookupSession
Description

Gets the OsidSession associated with the input enabler mapping lookup service.

Returnosid.control.rules.InputEnablerRuleLookupSessionan InputEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsInputEnablerRuleLookup() is true.
MethodgetInputEnablerRuleLookupSessionForSystem
Description

Gets the OsidSession associated with the input enabler mapping lookup service.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.InputEnablerRuleLookupSessionan InputEnablerRuleLookupSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInputEnablerRuleLookup() and supportsVisibleFederation() are true.
MethodgetInputEnablerRuleApplicationSession
Description

Gets the OsidSession associated with the input enabler assignment service.

Returnosid.control.rules.InputEnablerRuleApplicationSessionan InputEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsInputEnablerRuleApplication() is true.
MethodgetInputEnablerRuleApplicationSessionForSystem
Description

Gets the OsidSession associated with the input enabler assignment service for the given system.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.InputEnablerRuleApplicationSessionan InputEnablerRuleApplicationSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInputEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInputEnablerRuleApplication() and supportsVisibleFederation() are true.
MethodgetTriggerEnablerLookupSession
Description

Gets the OsidSession associated with the trigger enabler lookup service.

Returnosid.control.rules.TriggerEnablerLookupSessiona TriggerEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsTriggerEnablerLookup() is true.
MethodgetTriggerEnablerLookupSessionForSystem
Description

Gets the OsidSession associated with the trigger enabler lookup service for the given system.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.TriggerEnablerLookupSessiona TriggerEnablerLookupSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTriggerEnablerLookup() and supportsVisibleFederation() are true.
MethodgetTriggerEnablerQuerySession
Description

Gets the OsidSession associated with the trigger enabler query service.

Returnosid.control.rules.TriggerEnablerQuerySessiona TriggerEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsTriggerEnablerQuery() is true.
MethodgetTriggerEnablerQuerySessionForSystem
Description

Gets the OsidSession associated with the trigger enabler query service for the given system.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.TriggerEnablerQuerySessiona TriggerEnablerQuerySession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTriggerEnablerQuery() and supportsVisibleFederation() are true.
MethodgetTriggerEnablerSearchSession
Description

Gets the OsidSession associated with the trigger enabler search service.

Returnosid.control.rules.TriggerEnablerSearchSessiona TriggerEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsTriggerEnablerSearch() is true.
MethodgetTriggerEnablerSearchSessionForSystem
Description

Gets the OsidSession associated with the trigger enablers earch service for the given system.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.TriggerEnablerSearchSessiona TriggerEnablerSearchSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTriggerEnablerSearch() and supportsVisibleFederation() are true.
MethodgetTriggerEnablerAdminSession
Description

Gets the OsidSession associated with the trigger enabler administration service.

Returnosid.control.rules.TriggerEnablerAdminSessiona TriggerEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsTriggerEnablerAdmin() is true.
MethodgetTriggerEnablerAdminSessionForSystem
Description

Gets the OsidSession associated with the trigger enabler administration service for the given system.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.TriggerEnablerAdminSessiona TriggerEnablerAdminSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTriggerEnablerAdmin() and supportsVisibleFederation() are true.
MethodgetTriggerEnablerNotificationSession
Description

Gets the OsidSession associated with the trigger enabler notification service.

Parametersosid.control.rules.TriggerEnablerReceivertriggerEnablerReceiverthe notification callback
Returnosid.control.rules.TriggerEnablerNotificationSessiona TriggerEnablerNotificationSession
ErrorsNULL_ARGUMENT triggerEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsTriggerEnablerNotification() is true.
MethodgetTriggerEnablerNotificationSessionForSystem
Description

Gets the OsidSession associated with the trigger enabler notification service for the given system.

Parametersosid.control.rules.TriggerEnablerReceivertriggerEnablerReceiverthe notification callback
osid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.TriggerEnablerNotificationSessiona TriggerEnablerNotificationSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT triggerEnablerReceiver or systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTriggerEnablerNotification() and supportsVisibleFederation() are true.
MethodgetTriggerEnablerSystemSession
Description

Gets the OsidSession to lookup trigger enabler/system mappings for trigger enablers.

Returnosid.control.rules.TriggerEnablerSystemSessiona TriggerEnablerSystemSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerEnablerSystem() is false
ComplianceoptionalThis method must be implemented if supportsTriggerEnablerSystem() is true.
MethodgetTriggerEnablerSystemAssignmentSession
Description

Gets the OsidSession associated with assigning trigger enablers to systems.

Returnosid.control.rules.TriggerEnablerSystemAssignmentSessiona TriggerEnablerSystemAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerEnablerSystemAssignment() is false
ComplianceoptionalThis method must be implemented if supportsTriggerEnablerSystemAssignment() is true.
MethodgetTriggerEnablerSmartSystemSession
Description

Gets the OsidSession to manage trigger enabler smart systems.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.TriggerEnablerSmartSystemSessiona TriggerEnablerSmartSystemSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerEnablerSmartSystem() is false
ComplianceoptionalThis method must be implemented if supportsTriggerEnablerSmartSystem() is true.
MethodgetTriggerEnablerRuleLookupSession
Description

Gets the OsidSession associated with the trigger enabler mapping lookup service.

Returnosid.control.rules.TriggerEnablerRuleLookupSessiona TriggerEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsTriggerEnablerRuleLookup() is true.
MethodgetTriggerEnablerRuleLookupSessionForSystem
Description

Gets the OsidSession associated with the trigger enabler mapping lookup service for the given system.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.TriggerEnablerRuleLookupSessiona TriggerEnablerRuleLookupSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTriggerEnablerRuleLookup() and supportsVisibleFederation() are true.
MethodgetTriggerEnablerRuleApplicationSession
Description

Gets the OsidSession associated with the trigger enabler assignment service.

Returnosid.control.rules.TriggerEnablerRuleApplicationSessiona TriggerEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsTriggerEnablerRuleApplication() is true.
MethodgetTriggerEnablerRuleApplicationSessionForSystem
Description

Gets the OsidSession associated with the trigger enabler assignment service for the given system.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.TriggerEnablerRuleApplicationSessiona TriggerEnablerRuleApplicationSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsTriggerEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsTriggerEnablerRuleApplication() and supportsVisibleFederation() are true.
MethodgetActionEnablerLookupSession
Description

Gets the OsidSession associated with the action enabler lookup service.

Returnosid.control.rules.ActionEnablerLookupSessionan ActionEnablerLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsActionEnablerLookup() is true.
MethodgetActionEnablerLookupSessionForSystem
Description

Gets the OsidSession associated with the action enabler lookup service for the given system.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.ActionEnablerLookupSessionan ActionEnablerLookupSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsActionEnablerLookup() and supportsVisibleFederation() are true.
MethodgetActionEnablerQuerySession
Description

Gets the OsidSession associated with the action enabler query service.

Returnosid.control.rules.ActionEnablerQuerySessionan ActionEnablerQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsActionEnablerQuery() is true.
MethodgetActionEnablerQuerySessionForSystem
Description

Gets the OsidSession associated with the action enabler query service for the given system.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.ActionEnablerQuerySessionan ActionEnablerQuerySession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsActionEnablerQuery() and supportsVisibleFederation() are true.
MethodgetActionEnablerSearchSession
Description

Gets the OsidSession associated with the action enabler search service.

Returnosid.control.rules.ActionEnablerSearchSessionan ActionEnablerSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsActionEnablerSearch() is true.
MethodgetActionEnablerSearchSessionForSystem
Description

Gets the OsidSession associated with the action enablers earch service for the given system.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.ActionEnablerSearchSessionan ActionEnablerSearchSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsActionEnablerSearch() and supportsVisibleFederation() are true.
MethodgetActionEnablerAdminSession
Description

Gets the OsidSession associated with the action enabler administration service.

Returnosid.control.rules.ActionEnablerAdminSessionan ActionEnablerAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsActionEnablerAdmin() is true.
MethodgetActionEnablerAdminSessionForSystem
Description

Gets the OsidSession associated with the action enabler administration service for the given system.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.ActionEnablerAdminSessionan ActionEnablerAdminSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsActionEnablerAdmin() and supportsVisibleFederation() are true.
MethodgetActionEnablerNotificationSession
Description

Gets the OsidSession associated with the action enabler notification service.

Parametersosid.control.rules.ActionEnablerReceiveractionEnablerReceiverthe notification callback
Returnosid.control.rules.ActionEnablerNotificationSessionan ActionEnablerNotificationSession
ErrorsNULL_ARGUMENT actionEnablerReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsActionEnablerNotification() is true.
MethodgetActionEnablerNotificationSessionForSystem
Description

Gets the OsidSession associated with the action enabler notification service for the given system.

Parametersosid.control.rules.ActionEnablerReceiveractionEnablerReceiverthe notification callback
osid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.ActionEnablerNotificationSessionan ActionEnablerNotificationSession
ErrorsNOT_FOUNDno system found by the given Id
NULL_ARGUMENT actionEnablerReceiver or systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsActionEnablerNotification() and supportsVisibleFederation() are true.
MethodgetActionEnablerSystemSession
Description

Gets the OsidSession to lookup action enabler/system mappings for action enablers.

Returnosid.control.rules.ActionEnablerSystemSessionan ActionEnablerSystemSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionEnablerSystem() is false
ComplianceoptionalThis method must be implemented if supportsActionEnablerSystem() is true.
MethodgetActionEnablerSystemAssignmentSession
Description

Gets the OsidSession associated with assigning action enablers to systems.

Returnosid.control.rules.ActionEnablerSystemAssignmentSessionan ActionEnablerSystemAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionEnablerSystemAssignment() is false
ComplianceoptionalThis method must be implemented if supportsActionEnablerSystemAssignment() is true.
MethodgetActionEnablerSmartSystemSession
Description

Gets the OsidSession to manage action enabler smart systems.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.ActionEnablerSmartSystemSessionan ActionEnablerSmartSystemSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionEnablerSmartSystem() is false
ComplianceoptionalThis method must be implemented if supportsActionEnablerSmartSystem() is true.
MethodgetActionEnablerRuleLookupSession
Description

Gets the OsidSession associated with the action enabler mapping lookup service.

Returnosid.control.rules.ActionEnablerRuleLookupSessionan ActionEnablerRuleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsActionEnablerRuleLookup() is true.
MethodgetActionEnablerRuleLookupSessionForSystem
Description

Gets the OsidSession associated with the action enabler mapping lookup service for the given system.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.ActionEnablerRuleLookupSessionan ActionEnablerRuleLookupSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsActionEnablerRuleLookup() and supportsVisibleFederation() are true.
MethodgetActionEnablerRuleApplicationSession
Description

Gets the OsidSession associated with the action enabler assignment service.

Returnosid.control.rules.ActionEnablerRuleApplicationSessionan ActionEnablerRuleApplicationSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsActionEnablerRuleApplication() is true.
MethodgetActionEnablerRuleApplicationSessionForSystem
Description

Gets the OsidSession associated with the action enabler assignment service for the given system.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.control.rules.ActionEnablerRuleApplicationSessionan ActionEnablerRuleApplicationSession
ErrorsNOT_FOUNDno System found by the given Id
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsActionEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsActionEnablerRuleApplication() and supportsVisibleFederation() are true.