org.osid.control.rules

Interface ControlRulesManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, ControlRulesProfile, OsidManager, OsidProfile, Sourceable

public interface ControlRulesManager
extends OsidManager, ControlRulesProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
ActionEnablerAdminSession	getActionEnablerAdminSession() Gets the OsidSession associated with the action enabler administration service.
ActionEnablerAdminSession	getActionEnablerAdminSessionForSystem(Id systemId) Gets the OsidSession associated with the action enabler administration service for the given system.
ActionEnablerLookupSession	getActionEnablerLookupSession() Gets the OsidSession associated with the action enabler lookup service.
ActionEnablerLookupSession	getActionEnablerLookupSessionForSystem(Id systemId) Gets the OsidSession associated with the action enabler lookup service for the given system.
ActionEnablerNotificationSession	getActionEnablerNotificationSession(ActionEnablerReceiver actionEnablerReceiver) Gets the OsidSession associated with the action enabler notification service.
ActionEnablerNotificationSession	getActionEnablerNotificationSessionForSystem(ActionEnablerReceiver actionEnablerReceiver, Id systemId) Gets the OsidSession associated with the action enabler notification service for the given system.
ActionEnablerQuerySession	getActionEnablerQuerySession() Gets the OsidSession associated with the action enabler query service.
ActionEnablerQuerySession	getActionEnablerQuerySessionForSystem(Id systemId) Gets the OsidSession associated with the action enabler query service for the given system.
ActionEnablerRuleApplicationSession	getActionEnablerRuleApplicationSession() Gets the OsidSession associated with the action enabler assignment service.
ActionEnablerRuleApplicationSession	getActionEnablerRuleApplicationSessionForSystem(Id systemId) Gets the OsidSession associated with the action enabler assignment service for the given system.
ActionEnablerRuleLookupSession	getActionEnablerRuleLookupSession() Gets the OsidSession associated with the action enabler mapping lookup service.
ActionEnablerRuleLookupSession	getActionEnablerRuleLookupSessionForSystem(Id systemId) Gets the OsidSession associated with the action enabler mapping lookup service for the given system.
ActionEnablerSearchSession	getActionEnablerSearchSession() Gets the OsidSession associated with the action enabler search service.
ActionEnablerSearchSession	getActionEnablerSearchSessionForSystem(Id systemId) Gets the OsidSession associated with the action enablers earch service for the given system.
ActionEnablerSmartSystemSession	getActionEnablerSmartSystemSession(Id systemId) Gets the OsidSession to manage action enabler smart systems.
ActionEnablerSystemAssignmentSession	getActionEnablerSystemAssignmentSession() Gets the OsidSession associated with assigning action enablers to systems.
ActionEnablerSystemSession	getActionEnablerSystemSession() Gets the OsidSession to lookup action enabler/system mappings for action enablers.
DeviceEnablerAdminSession	getDeviceEnablerAdminSession() Gets the OsidSession associated with the device enabler administration service.
DeviceEnablerAdminSession	getDeviceEnablerAdminSessionForSystem(Id systemId) Gets the OsidSession associated with the device enabler administration service for the given system.
DeviceEnablerLookupSession	getDeviceEnablerLookupSession() Gets the OsidSession associated with the device enabler lookup service.
DeviceEnablerLookupSession	getDeviceEnablerLookupSessionForSystem(Id systemId) Gets the OsidSession associated with the device enabler lookup service for the given system.
DeviceEnablerNotificationSession	getDeviceEnablerNotificationSession(DeviceEnablerReceiver deviceEnablerReceiver) Gets the OsidSession associated with the device enabler notification service.
DeviceEnablerNotificationSession	getDeviceEnablerNotificationSessionForSystem(DeviceEnablerReceiver deviceEnablerReceiver, Id systemId) Gets the OsidSession associated with the device enabler notification service for the given system.
DeviceEnablerQuerySession	getDeviceEnablerQuerySession() Gets the OsidSession associated with the device enabler query service.
DeviceEnablerQuerySession	getDeviceEnablerQuerySessionForSystem(Id systemId) Gets the OsidSession associated with the device enabler query service for the given System.
DeviceEnablerRuleApplicationSession	getDeviceEnablerRuleApplicationSession() Gets the OsidSession associated with the device enabler assignment service.
DeviceEnablerRuleApplicationSession	getDeviceEnablerRuleApplicationSessionForSystem(Id systemId) Gets the OsidSession associated with the device enabler assignment service for the given system.
DeviceEnablerRuleLookupSession	getDeviceEnablerRuleLookupSession() Gets the OsidSession associated with the device enabler mapping lookup service.
DeviceEnablerRuleLookupSession	getDeviceEnablerRuleLookupSessionForSystem(Id systemId) Gets the OsidSession associated with the device enabler mapping lookup service for the given system.
DeviceEnablerSearchSession	getDeviceEnablerSearchSession() Gets the OsidSession associated with the device enabler search service.
DeviceEnablerSearchSession	getDeviceEnablerSearchSessionForSystem(Id systemId) Gets the OsidSession associated with the device enablers earch service for the given system.
DeviceEnablerSmartSystemSession	getDeviceEnablerSmartSystemSession(Id systemId) Gets the OsidSession to manage device enabler smart systems.
DeviceEnablerSystemAssignmentSession	getDeviceEnablerSystemAssignmentSession() Gets the OsidSession associated with assigning device enablers to systems.
DeviceEnablerSystemSession	getDeviceEnablerSystemSession() Gets the OsidSession to lookup device enabler/system mappings for device enablers.
InputEnablerAdminSession	getInputEnablerAdminSession() Gets the OsidSession associated with the input enabler administration service.
InputEnablerAdminSession	getInputEnablerAdminSessionForSystem(Id systemId) Gets the OsidSession associated with the input enabler administration service for the given system.
InputEnablerLookupSession	getInputEnablerLookupSession() Gets the OsidSession associated with the input enabler lookup service.
InputEnablerLookupSession	getInputEnablerLookupSessionForSystem(Id systemId) Gets the OsidSession associated with the input enabler lookup service for the given system.
InputEnablerNotificationSession	getInputEnablerNotificationSession(InputEnablerReceiver inputEnablerReceiver) Gets the OsidSession associated with the input enabler notification service.
InputEnablerNotificationSession	getInputEnablerNotificationSessionForSystem(InputEnablerReceiver inputEnablerReceiver, Id systemId) Gets the OsidSession associated with the input enabler notification service for the given system.
InputEnablerQuerySession	getInputEnablerQuerySession() Gets the OsidSession associated with the input enabler query service.
InputEnablerQuerySession	getInputEnablerQuerySessionForSystem(Id systemId) Gets the OsidSession associated with the input enabler query service for the given system.
InputEnablerRuleApplicationSession	getInputEnablerRuleApplicationSession() Gets the OsidSession associated with the input enabler assignment service.
InputEnablerRuleApplicationSession	getInputEnablerRuleApplicationSessionForSystem(Id systemId) Gets the OsidSession associated with the input enabler assignment service for the given system.
InputEnablerRuleLookupSession	getInputEnablerRuleLookupSession() Gets the OsidSession associated with the input enabler mapping lookup service.
InputEnablerRuleLookupSession	getInputEnablerRuleLookupSessionForSystem(Id systemId) Gets the OsidSession associated with the input enabler mapping lookup service.
InputEnablerSearchSession	getInputEnablerSearchSession() Gets the OsidSession associated with the input enabler search service.
InputEnablerSearchSession	getInputEnablerSearchSessionForSystem(Id systemId) Gets the OsidSession associated with the input enablers earch service for the given system.
InputEnablerSmartSystemSession	getInputEnablerSmartSystemSession(Id systemId) Gets the OsidSession to manage input enabler smart systems.
InputEnablerSystemAssignmentSession	getInputEnablerSystemAssignmentSession() Gets the OsidSession associated with assigning input enablers to systems.
InputEnablerSystemSession	getInputEnablerSystemSession() Gets the OsidSession to lookup input enabler/system mappings for input enablers.
TriggerEnablerAdminSession	getTriggerEnablerAdminSession() Gets the OsidSession associated with the trigger enabler administration service.
TriggerEnablerAdminSession	getTriggerEnablerAdminSessionForSystem(Id systemId) Gets the OsidSession associated with the trigger enabler administration service for the given system.
TriggerEnablerLookupSession	getTriggerEnablerLookupSession() Gets the OsidSession associated with the trigger enabler lookup service.
TriggerEnablerLookupSession	getTriggerEnablerLookupSessionForSystem(Id systemId) Gets the OsidSession associated with the trigger enabler lookup service for the given system.
TriggerEnablerNotificationSession	getTriggerEnablerNotificationSession(TriggerEnablerReceiver triggerEnablerReceiver) Gets the OsidSession associated with the trigger enabler notification service.
TriggerEnablerNotificationSession	getTriggerEnablerNotificationSessionForSystem(TriggerEnablerReceiver triggerEnablerReceiver, Id systemId) Gets the OsidSession associated with the trigger enabler notification service for the given system.
TriggerEnablerQuerySession	getTriggerEnablerQuerySession() Gets the OsidSession associated with the trigger enabler query service.
TriggerEnablerQuerySession	getTriggerEnablerQuerySessionForSystem(Id systemId) Gets the OsidSession associated with the trigger enabler query service for the given system.
TriggerEnablerRuleApplicationSession	getTriggerEnablerRuleApplicationSession() Gets the OsidSession associated with the trigger enabler assignment service.
TriggerEnablerRuleApplicationSession	getTriggerEnablerRuleApplicationSessionForSystem(Id systemId) Gets the OsidSession associated with the trigger enabler assignment service for the given system.
TriggerEnablerRuleLookupSession	getTriggerEnablerRuleLookupSession() Gets the OsidSession associated with the trigger enabler mapping lookup service.
TriggerEnablerRuleLookupSession	getTriggerEnablerRuleLookupSessionForSystem(Id systemId) Gets the OsidSession associated with the trigger enabler mapping lookup service for the given system.
TriggerEnablerSearchSession	getTriggerEnablerSearchSession() Gets the OsidSession associated with the trigger enabler search service.
TriggerEnablerSearchSession	getTriggerEnablerSearchSessionForSystem(Id systemId) Gets the OsidSession associated with the trigger enablers earch service for the given system.
TriggerEnablerSmartSystemSession	getTriggerEnablerSmartSystemSession(Id systemId) Gets the OsidSession to manage trigger enabler smart systems.
TriggerEnablerSystemAssignmentSession	getTriggerEnablerSystemAssignmentSession() Gets the OsidSession associated with assigning trigger enablers to systems.
TriggerEnablerSystemSession	getTriggerEnablerSystemSession() Gets the OsidSession to lookup trigger enabler/system mappings for trigger enablers.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.control.rules.ControlRulesProfile

getActionEnablerRecordTypes, getActionEnablerSearchRecordTypes, getDeviceEnablerRecordTypes, getDeviceEnablerSearchRecordTypes, getInputEnablerRecordTypes, getInputEnablerSearchRecordTypes, getTriggerEnablerRecordTypes, getTriggerEnablerSearchRecordTypes, supportsActionEnablerAdmin, supportsActionEnablerLookup, supportsActionEnablerNotification, supportsActionEnablerQuery, supportsActionEnablerRecordType, supportsActionEnablerSearch, supportsActionEnablerSearchRecordType, supportsActionEnablerSmartSystem, supportsActionEnablerSystem, supportsActionEnablerSystemAssignment, supportsDeviceEnablerAdmin, supportsDeviceEnablerLookup, supportsDeviceEnablerNotification, supportsDeviceEnablerQuery, supportsDeviceEnablerRecordType, supportsDeviceEnablerSearch, supportsDeviceEnablerSearchRecordType, supportsDeviceEnablerSmartSystem, supportsDeviceEnablerSystem, supportsDeviceEnablerSystemAssignment, supportsInputEnablerAdmin, supportsInputEnablerLookup, supportsInputEnablerNotification, supportsInputEnablerQuery, supportsInputEnablerRecordType, supportsInputEnablerRuleApplication, supportsInputEnablerRuleLookup, supportsInputEnablerSearch, supportsInputEnablerSearchRecordType, supportsInputEnablerSmartSystem, supportsInputEnablerSystem, supportsInputEnablerSystemAssignment, supportsTriggerEnablerAdmin, supportsTriggerEnablerLookup, supportsTriggerEnablerNotification, supportsTriggerEnablerQuery, supportsTriggerEnablerRecordType, supportsTriggerEnablerRuleApplication, supportsTriggerEnablerRuleLookup, supportsTriggerEnablerSearch, supportsTriggerEnablerSearchRecordType, supportsTriggerEnablerSmartSystem, supportsTriggerEnablerSystem, supportsTriggerEnablerSystemAssignment, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getDeviceEnablerLookupSession

DeviceEnablerLookupSession getDeviceEnablerLookupSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the device enabler lookup service.

Returns:

a DeviceEnablerLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceEnablerLookup() is false

Compliance:

optional - This method must be implemented if supportsDeviceEnablerLookup() is true.

getDeviceEnablerLookupSessionForSystem

DeviceEnablerLookupSession getDeviceEnablerLookupSessionForSystem(Id systemId)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a DeviceEnablerLookupSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceEnablerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDeviceEnablerLookup() and supportsVisibleFederation() are true.

getDeviceEnablerQuerySession

DeviceEnablerQuerySession getDeviceEnablerQuerySession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the device enabler query service.

Returns:

a DeviceEnablerQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceEnablerQuery() is false

Compliance:

optional - This method must be implemented if supportsDeviceEnablerQuery() is true.

getDeviceEnablerQuerySessionForSystem

DeviceEnablerQuerySession getDeviceEnablerQuerySessionForSystem(Id systemId)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a DeviceEnablerQuerySession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceEnablerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDeviceEnablerQuery() and supportsVisibleFederation() are true.

getDeviceEnablerSearchSession

DeviceEnablerSearchSession getDeviceEnablerSearchSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the device enabler search service.

Returns:

a DeviceEnablerSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceEnablerSearch() is false

Compliance:

optional - This method must be implemented if supportsDeviceEnablerSearch() is true.

getDeviceEnablerSearchSessionForSystem

DeviceEnablerSearchSession getDeviceEnablerSearchSessionForSystem(Id systemId)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a DeviceEnablerSearchSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceEnablerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDeviceEnablerSearch() and supportsVisibleFederation() are true.

getDeviceEnablerAdminSession

DeviceEnablerAdminSession getDeviceEnablerAdminSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the device enabler administration service.

Returns:

a DeviceEnablerAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceEnablerAdmin() is false

Compliance:

optional - This method must be implemented if supportsDeviceEnablerAdmin() is true.

getDeviceEnablerAdminSessionForSystem

DeviceEnablerAdminSession getDeviceEnablerAdminSessionForSystem(Id systemId)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a DeviceEnablerAdminSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDeviceEnablerAdmin() and supportsVisibleFederation() are true.

getDeviceEnablerNotificationSession

DeviceEnablerNotificationSession getDeviceEnablerNotificationSession(DeviceEnablerReceiver deviceEnablerReceiver)
                                                                     throws OperationFailedException

Gets the OsidSession associated with the device enabler notification service.

Parameters:

deviceEnablerReceiver - the notification callback

Returns:

a DeviceEnablerNotificationSession

Throws:

NullArgumentException - deviceEnablerReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceEnablerNotification() is false

Compliance:

optional - This method must be implemented if supportsDeviceEnablerNotification() is true.

getDeviceEnablerNotificationSessionForSystem

DeviceEnablerNotificationSession getDeviceEnablerNotificationSessionForSystem(DeviceEnablerReceiver deviceEnablerReceiver,
                                                                            Id systemId)
                                                                              throws NotFoundException,
                                                                                     OperationFailedException

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

Parameters:

deviceEnablerReceiver - the notification callback

systemId - the Id of the System

Returns:

a DeviceEnablerNotificationSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - deviceEnablerReceiver or systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceEnablerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDeviceEnablerNotification() and supportsVisibleFederation() are true.

getDeviceEnablerSystemSession

DeviceEnablerSystemSession getDeviceEnablerSystemSession()
                                                         throws OperationFailedException

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

Returns:

a DeviceEnablerSystemSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceEnablerSystem() is false

Compliance:

optional - This method must be implemented if supportsDeviceEnablerSystem() is true.

getDeviceEnablerSystemAssignmentSession

DeviceEnablerSystemAssignmentSession getDeviceEnablerSystemAssignmentSession()
                                                                             throws OperationFailedException

Gets the OsidSession associated with assigning device enablers to systems.

Returns:

a DeviceEnablerSystemAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceEnablerSystemAssignment() is false

Compliance:

optional - This method must be implemented if supportsDeviceEnablerSystemAssignment() is true.

getDeviceEnablerSmartSystemSession

DeviceEnablerSmartSystemSession getDeviceEnablerSmartSystemSession(Id systemId)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

Gets the OsidSession to manage device enabler smart systems.

Parameters:

systemId - the Id of the System

Returns:

a DeviceEnablerSmartSystemSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceEnablerSmartSystem() is false

Compliance:

optional - This method must be implemented if supportsDeviceEnablerSmartSystem() is true.

getDeviceEnablerRuleLookupSession

DeviceEnablerRuleLookupSession getDeviceEnablerRuleLookupSession()
                                                                 throws OperationFailedException

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

Returns:

a DeviceEnablerRuleLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceEnablerRuleLookup() is false

Compliance:

optional - This method must be implemented if supportsDeviceEnablerRuleLookup() is true.

getDeviceEnablerRuleLookupSessionForSystem

DeviceEnablerRuleLookupSession getDeviceEnablerRuleLookupSessionForSystem(Id systemId)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a DeviceEnablerRuleLookupSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDeviceEnablerRuleLookup() and supportsVisibleFederation() are true.

getDeviceEnablerRuleApplicationSession

DeviceEnablerRuleApplicationSession getDeviceEnablerRuleApplicationSession()
                                                                           throws OperationFailedException

Gets the OsidSession associated with the device enabler assignment service.

Returns:

a DeviceEnablerRuleApplicationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceEnablerRuleApplication() is false

Compliance:

optional - This method must be implemented if supportsDeviceEnablerRuleApplication() is true.

getDeviceEnablerRuleApplicationSessionForSystem

DeviceEnablerRuleApplicationSession getDeviceEnablerRuleApplicationSessionForSystem(Id systemId)
                                                                                    throws NotFoundException,
                                                                                           OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a DeviceEnablerRuleApplicationSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDeviceEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsDeviceEnablerRuleApplication() and supportsVisibleFederation() are true.

getInputEnablerLookupSession

InputEnablerLookupSession getInputEnablerLookupSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the input enabler lookup service.

Returns:

an InputEnablerLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInputEnablerLookup() is false

Compliance:

optional - This method must be implemented if supportsInputEnablerLookup() is true.

getInputEnablerLookupSessionForSystem

InputEnablerLookupSession getInputEnablerLookupSessionForSystem(Id systemId)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

an InputEnablerLookupSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputEnablerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInputEnablerLookup() and supportsVisibleFederation() are true.

getInputEnablerQuerySession

InputEnablerQuerySession getInputEnablerQuerySession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the input enabler query service.

Returns:

an InputEnablerQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInputEnablerQuery() is false

Compliance:

optional - This method must be implemented if supportsInputEnablerQuery() is true.

getInputEnablerQuerySessionForSystem

InputEnablerQuerySession getInputEnablerQuerySessionForSystem(Id systemId)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

an InputEnablerQuerySession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputEnablerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInputEnablerQuery() and supportsVisibleFederation() are true.

getInputEnablerSearchSession

InputEnablerSearchSession getInputEnablerSearchSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the input enabler search service.

Returns:

an InputEnablerSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInputEnablerSearch() is false

Compliance:

optional - This method must be implemented if supportsInputEnablerSearch() is true.

getInputEnablerSearchSessionForSystem

InputEnablerSearchSession getInputEnablerSearchSessionForSystem(Id systemId)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

an InputEnablerSearchSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputEnablerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInputEnablerSearch() and supportsVisibleFederation() are true.

getInputEnablerAdminSession

InputEnablerAdminSession getInputEnablerAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the input enabler administration service.

Returns:

an InputEnablerAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInputEnablerAdmin() is false

Compliance:

optional - This method must be implemented if supportsInputEnablerAdmin() is true.

getInputEnablerAdminSessionForSystem

InputEnablerAdminSession getInputEnablerAdminSessionForSystem(Id systemId)
                                                              throws NotFoundException,
                                                                     OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

an InputEnablerAdminSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInputEnablerAdmin() and supportsVisibleFederation() are true.

getInputEnablerNotificationSession

InputEnablerNotificationSession getInputEnablerNotificationSession(InputEnablerReceiver inputEnablerReceiver)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the input enabler notification service.

Parameters:

inputEnablerReceiver - the notification callback

Returns:

an InputEnablerNotificationSession

Throws:

NullArgumentException - inputEnablerReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputEnablerNotification() is false

Compliance:

optional - This method must be implemented if supportsInputEnablerNotification() is true.

getInputEnablerNotificationSessionForSystem

InputEnablerNotificationSession getInputEnablerNotificationSessionForSystem(InputEnablerReceiver inputEnablerReceiver,
                                                                          Id systemId)
                                                                            throws NotFoundException,
                                                                                   OperationFailedException

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

Parameters:

inputEnablerReceiver - the notification callback

systemId - the Id of the System

Returns:

an InputEnablerNotificationSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - inputEnablerReceiver or systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputEnablerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInputEnablerNotification() and supportsVisibleFederation() are true.

getInputEnablerSystemSession

InputEnablerSystemSession getInputEnablerSystemSession()
                                                       throws OperationFailedException

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

Returns:

an InputEnablerSystemSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInputEnablerSystem() is false

Compliance:

optional - This method must be implemented if supportsInputEnablerSystem() is true.

getInputEnablerSystemAssignmentSession

InputEnablerSystemAssignmentSession getInputEnablerSystemAssignmentSession()
                                                                           throws OperationFailedException

Gets the OsidSession associated with assigning input enablers to systems.

Returns:

an InputEnablerSystemAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInputEnablerSystemAssignment() is false

Compliance:

optional - This method must be implemented if supportsInputEnablerSystemAssignment() is true.

getInputEnablerSmartSystemSession

InputEnablerSmartSystemSession getInputEnablerSmartSystemSession(Id systemId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession to manage input enabler smart systems.

Parameters:

systemId - the Id of the System

Returns:

an InputEnablerSmartSystemSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputEnablerSmartSystem() is false

Compliance:

optional - This method must be implemented if supportsInputEnablerSmartSystem() is true.

getInputEnablerRuleLookupSession

InputEnablerRuleLookupSession getInputEnablerRuleLookupSession()
                                                               throws OperationFailedException

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

Returns:

an InputEnablerRuleLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInputEnablerRuleLookup() is false

Compliance:

optional - This method must be implemented if supportsInputEnablerRuleLookup() is true.

getInputEnablerRuleLookupSessionForSystem

InputEnablerRuleLookupSession getInputEnablerRuleLookupSessionForSystem(Id systemId)
                                                                        throws NotFoundException,
                                                                               OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

an InputEnablerRuleLookupSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInputEnablerRuleLookup() and supportsVisibleFederation() are true.

getInputEnablerRuleApplicationSession

InputEnablerRuleApplicationSession getInputEnablerRuleApplicationSession()
                                                                         throws OperationFailedException

Gets the OsidSession associated with the input enabler assignment service.

Returns:

an InputEnablerRuleApplicationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInputEnablerRuleApplication() is false

Compliance:

optional - This method must be implemented if supportsInputEnablerRuleApplication() is true.

getInputEnablerRuleApplicationSessionForSystem

InputEnablerRuleApplicationSession getInputEnablerRuleApplicationSessionForSystem(Id systemId)
                                                                                  throws NotFoundException,
                                                                                         OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

an InputEnablerRuleApplicationSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInputEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInputEnablerRuleApplication() and supportsVisibleFederation() are true.

getTriggerEnablerLookupSession

TriggerEnablerLookupSession getTriggerEnablerLookupSession()
                                                           throws OperationFailedException

Gets the OsidSession associated with the trigger enabler lookup service.

Returns:

a TriggerEnablerLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerEnablerLookup() is false

Compliance:

optional - This method must be implemented if supportsTriggerEnablerLookup() is true.

getTriggerEnablerLookupSessionForSystem

TriggerEnablerLookupSession getTriggerEnablerLookupSessionForSystem(Id systemId)
                                                                    throws NotFoundException,
                                                                           OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a TriggerEnablerLookupSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerEnablerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsTriggerEnablerLookup() and supportsVisibleFederation() are true.

getTriggerEnablerQuerySession

TriggerEnablerQuerySession getTriggerEnablerQuerySession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the trigger enabler query service.

Returns:

a TriggerEnablerQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerEnablerQuery() is false

Compliance:

optional - This method must be implemented if supportsTriggerEnablerQuery() is true.

getTriggerEnablerQuerySessionForSystem

TriggerEnablerQuerySession getTriggerEnablerQuerySessionForSystem(Id systemId)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a TriggerEnablerQuerySession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerEnablerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsTriggerEnablerQuery() and supportsVisibleFederation() are true.

getTriggerEnablerSearchSession

TriggerEnablerSearchSession getTriggerEnablerSearchSession()
                                                           throws OperationFailedException

Gets the OsidSession associated with the trigger enabler search service.

Returns:

a TriggerEnablerSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerEnablerSearch() is false

Compliance:

optional - This method must be implemented if supportsTriggerEnablerSearch() is true.

getTriggerEnablerSearchSessionForSystem

TriggerEnablerSearchSession getTriggerEnablerSearchSessionForSystem(Id systemId)
                                                                    throws NotFoundException,
                                                                           OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a TriggerEnablerSearchSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerEnablerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsTriggerEnablerSearch() and supportsVisibleFederation() are true.

getTriggerEnablerAdminSession

TriggerEnablerAdminSession getTriggerEnablerAdminSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the trigger enabler administration service.

Returns:

a TriggerEnablerAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerEnablerAdmin() is false

Compliance:

optional - This method must be implemented if supportsTriggerEnablerAdmin() is true.

getTriggerEnablerAdminSessionForSystem

TriggerEnablerAdminSession getTriggerEnablerAdminSessionForSystem(Id systemId)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a TriggerEnablerAdminSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsTriggerEnablerAdmin() and supportsVisibleFederation() are true.

getTriggerEnablerNotificationSession

TriggerEnablerNotificationSession getTriggerEnablerNotificationSession(TriggerEnablerReceiver triggerEnablerReceiver)
                                                                       throws OperationFailedException

Gets the OsidSession associated with the trigger enabler notification service.

Parameters:

triggerEnablerReceiver - the notification callback

Returns:

a TriggerEnablerNotificationSession

Throws:

NullArgumentException - triggerEnablerReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerEnablerNotification() is false

Compliance:

optional - This method must be implemented if supportsTriggerEnablerNotification() is true.

getTriggerEnablerNotificationSessionForSystem

TriggerEnablerNotificationSession getTriggerEnablerNotificationSessionForSystem(TriggerEnablerReceiver triggerEnablerReceiver,
                                                                              Id systemId)
                                                                                throws NotFoundException,
                                                                                       OperationFailedException

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

Parameters:

triggerEnablerReceiver - the notification callback

systemId - the Id of the System

Returns:

a TriggerEnablerNotificationSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - triggerEnablerReceiver or systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerEnablerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsTriggerEnablerNotification() and supportsVisibleFederation() are true.

getTriggerEnablerSystemSession

TriggerEnablerSystemSession getTriggerEnablerSystemSession()
                                                           throws OperationFailedException

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

Returns:

a TriggerEnablerSystemSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerEnablerSystem() is false

Compliance:

optional - This method must be implemented if supportsTriggerEnablerSystem() is true.

getTriggerEnablerSystemAssignmentSession

TriggerEnablerSystemAssignmentSession getTriggerEnablerSystemAssignmentSession()
                                                                               throws OperationFailedException

Gets the OsidSession associated with assigning trigger enablers to systems.

Returns:

a TriggerEnablerSystemAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerEnablerSystemAssignment() is false

Compliance:

optional - This method must be implemented if supportsTriggerEnablerSystemAssignment() is true.

getTriggerEnablerSmartSystemSession

TriggerEnablerSmartSystemSession getTriggerEnablerSmartSystemSession(Id systemId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

Gets the OsidSession to manage trigger enabler smart systems.

Parameters:

systemId - the Id of the System

Returns:

a TriggerEnablerSmartSystemSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerEnablerSmartSystem() is false

Compliance:

optional - This method must be implemented if supportsTriggerEnablerSmartSystem() is true.

getTriggerEnablerRuleLookupSession

TriggerEnablerRuleLookupSession getTriggerEnablerRuleLookupSession()
                                                                   throws OperationFailedException

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

Returns:

a TriggerEnablerRuleLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerEnablerRuleLookup() is false

Compliance:

optional - This method must be implemented if supportsTriggerEnablerRuleLookup() is true.

getTriggerEnablerRuleLookupSessionForSystem

TriggerEnablerRuleLookupSession getTriggerEnablerRuleLookupSessionForSystem(Id systemId)
                                                                            throws NotFoundException,
                                                                                   OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a TriggerEnablerRuleLookupSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsTriggerEnablerRuleLookup() and supportsVisibleFederation() are true.

getTriggerEnablerRuleApplicationSession

TriggerEnablerRuleApplicationSession getTriggerEnablerRuleApplicationSession()
                                                                             throws OperationFailedException

Gets the OsidSession associated with the trigger enabler assignment service.

Returns:

a TriggerEnablerRuleApplicationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerEnablerRuleApplication() is false

Compliance:

optional - This method must be implemented if supportsTriggerEnablerRuleApplication() is true.

getTriggerEnablerRuleApplicationSessionForSystem

TriggerEnablerRuleApplicationSession getTriggerEnablerRuleApplicationSessionForSystem(Id systemId)
                                                                                      throws NotFoundException,
                                                                                             OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

a TriggerEnablerRuleApplicationSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsTriggerEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsTriggerEnablerRuleApplication() and supportsVisibleFederation() are true.

getActionEnablerLookupSession

ActionEnablerLookupSession getActionEnablerLookupSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the action enabler lookup service.

Returns:

an ActionEnablerLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActionEnablerLookup() is false

Compliance:

optional - This method must be implemented if supportsActionEnablerLookup() is true.

getActionEnablerLookupSessionForSystem

ActionEnablerLookupSession getActionEnablerLookupSessionForSystem(Id systemId)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

an ActionEnablerLookupSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionEnablerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsActionEnablerLookup() and supportsVisibleFederation() are true.

getActionEnablerQuerySession

ActionEnablerQuerySession getActionEnablerQuerySession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the action enabler query service.

Returns:

an ActionEnablerQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActionEnablerQuery() is false

Compliance:

optional - This method must be implemented if supportsActionEnablerQuery() is true.

getActionEnablerQuerySessionForSystem

ActionEnablerQuerySession getActionEnablerQuerySessionForSystem(Id systemId)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

an ActionEnablerQuerySession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionEnablerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsActionEnablerQuery() and supportsVisibleFederation() are true.

getActionEnablerSearchSession

ActionEnablerSearchSession getActionEnablerSearchSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the action enabler search service.

Returns:

an ActionEnablerSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActionEnablerSearch() is false

Compliance:

optional - This method must be implemented if supportsActionEnablerSearch() is true.

getActionEnablerSearchSessionForSystem

ActionEnablerSearchSession getActionEnablerSearchSessionForSystem(Id systemId)
                                                                  throws NotFoundException,
                                                                         OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

an ActionEnablerSearchSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionEnablerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsActionEnablerSearch() and supportsVisibleFederation() are true.

getActionEnablerAdminSession

ActionEnablerAdminSession getActionEnablerAdminSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the action enabler administration service.

Returns:

an ActionEnablerAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActionEnablerAdmin() is false

Compliance:

optional - This method must be implemented if supportsActionEnablerAdmin() is true.

getActionEnablerAdminSessionForSystem

ActionEnablerAdminSession getActionEnablerAdminSessionForSystem(Id systemId)
                                                                throws NotFoundException,
                                                                       OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

an ActionEnablerAdminSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsActionEnablerAdmin() and supportsVisibleFederation() are true.

getActionEnablerNotificationSession

ActionEnablerNotificationSession getActionEnablerNotificationSession(ActionEnablerReceiver actionEnablerReceiver)
                                                                     throws OperationFailedException

Gets the OsidSession associated with the action enabler notification service.

Parameters:

actionEnablerReceiver - the notification callback

Returns:

an ActionEnablerNotificationSession

Throws:

NullArgumentException - actionEnablerReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionEnablerNotification() is false

Compliance:

optional - This method must be implemented if supportsActionEnablerNotification() is true.

getActionEnablerNotificationSessionForSystem

ActionEnablerNotificationSession getActionEnablerNotificationSessionForSystem(ActionEnablerReceiver actionEnablerReceiver,
                                                                            Id systemId)
                                                                              throws NotFoundException,
                                                                                     OperationFailedException

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

Parameters:

actionEnablerReceiver - the notification callback

systemId - the Id of the System

Returns:

an ActionEnablerNotificationSession

Throws:

NotFoundException - no system found by the given Id

NullArgumentException - actionEnablerReceiver or systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionEnablerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsActionEnablerNotification() and supportsVisibleFederation() are true.

getActionEnablerSystemSession

ActionEnablerSystemSession getActionEnablerSystemSession()
                                                         throws OperationFailedException

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

Returns:

an ActionEnablerSystemSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActionEnablerSystem() is false

Compliance:

optional - This method must be implemented if supportsActionEnablerSystem() is true.

getActionEnablerSystemAssignmentSession

ActionEnablerSystemAssignmentSession getActionEnablerSystemAssignmentSession()
                                                                             throws OperationFailedException

Gets the OsidSession associated with assigning action enablers to systems.

Returns:

an ActionEnablerSystemAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActionEnablerSystemAssignment() is false

Compliance:

optional - This method must be implemented if supportsActionEnablerSystemAssignment() is true.

getActionEnablerSmartSystemSession

ActionEnablerSmartSystemSession getActionEnablerSmartSystemSession(Id systemId)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

Gets the OsidSession to manage action enabler smart systems.

Parameters:

systemId - the Id of the System

Returns:

an ActionEnablerSmartSystemSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionEnablerSmartSystem() is false

Compliance:

optional - This method must be implemented if supportsActionEnablerSmartSystem() is true.

getActionEnablerRuleLookupSession

ActionEnablerRuleLookupSession getActionEnablerRuleLookupSession()
                                                                 throws OperationFailedException

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

Returns:

an ActionEnablerRuleLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActionEnablerRuleLookup() is false

Compliance:

optional - This method must be implemented if supportsActionEnablerRuleLookup() is true.

getActionEnablerRuleLookupSessionForSystem

ActionEnablerRuleLookupSession getActionEnablerRuleLookupSessionForSystem(Id systemId)
                                                                          throws NotFoundException,
                                                                                 OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

an ActionEnablerRuleLookupSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsActionEnablerRuleLookup() and supportsVisibleFederation() are true.

getActionEnablerRuleApplicationSession

ActionEnablerRuleApplicationSession getActionEnablerRuleApplicationSession()
                                                                           throws OperationFailedException

Gets the OsidSession associated with the action enabler assignment service.

Returns:

an ActionEnablerRuleApplicationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsActionEnablerRuleApplication() is false

Compliance:

optional - This method must be implemented if supportsActionEnablerRuleApplication() is true.

getActionEnablerRuleApplicationSessionForSystem

ActionEnablerRuleApplicationSession getActionEnablerRuleApplicationSessionForSystem(Id systemId)
                                                                                    throws NotFoundException,
                                                                                           OperationFailedException

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

Parameters:

systemId - the Id of the System

Returns:

an ActionEnablerRuleApplicationSession

Throws:

NotFoundException - no System found by the given Id

NullArgumentException - systemId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsActionEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsActionEnablerRuleApplication() and supportsVisibleFederation() are true.