Interface ControlRulesManager

All Superinterfaces:

AutoCloseable, Closeable, ControlRulesProfile, OsidManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface 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

Modifier and Type	Method	Description
TypeList	getActionEnablerRecordTypes()	Gets the supported ActionEnabler record types.
TypeList	getActionEnablerSearchRecordTypes()	Gets the supported ActionEnabler search record types.
TypeList	getDeviceEnablerRecordTypes()	Gets the supported DeviceEnabler record types.
TypeList	getDeviceEnablerSearchRecordTypes()	Gets the supported DeviceEnabler search record types.
TypeList	getInputEnablerRecordTypes()	Gets the supported InputEnabler record types.
TypeList	getInputEnablerSearchRecordTypes()	Gets the supported InputEnabler search record types.
TypeList	getTriggerEnablerRecordTypes()	Gets the supported TriggerEnabler record types.
TypeList	getTriggerEnablerSearchRecordTypes()	Gets the supported TriggerEnabler search record types.
boolean	supportsActionEnablerAdmin()	Tests if an action enabler administrative service is supported.
boolean	supportsActionEnablerLookup()	Tests if looking up action enablers is supported.
boolean	supportsActionEnablerNotification()	Tests if an action enabler notification service is supported.
boolean	supportsActionEnablerQuery()	Tests if querying action enablers is supported.
boolean	supportsActionEnablerRecordType(Type actionEnablerRecordType)	Tests if the given ActionEnabler record type is supported.
boolean	supportsActionEnablerSearch()	Tests if searching action enablers is supported.
boolean	supportsActionEnablerSearchRecordType(Type actionEnablerSearchRecordType)	Tests if the given ActionEnabler search record type is supported.
boolean	supportsActionEnablerSmartSystem()	Tests if an action enabler system lookup service is supported.
boolean	supportsActionEnablerSystem()	Tests if an action enabler system lookup service is supported.
boolean	supportsActionEnablerSystemAssignment()	Tests if an action enabler system service is supported.
boolean	supportsDeviceEnablerAdmin()	Tests if a device enabler administrative service is supported.
boolean	supportsDeviceEnablerLookup()	Tests if looking up device enablers is supported.
boolean	supportsDeviceEnablerNotification()	Tests if a device enabler notification service is supported.
boolean	supportsDeviceEnablerQuery()	Tests if querying device enablers is supported.
boolean	supportsDeviceEnablerRecordType(Type deviceEnablerRecordType)	Tests if the given DeviceEnabler record type is supported.
boolean	supportsDeviceEnablerSearch()	Tests if searching device enablers is supported.
boolean	supportsDeviceEnablerSearchRecordType(Type deviceEnablerSearchRecordType)	Tests if the given DeviceEnabler search record type is supported.
boolean	supportsDeviceEnablerSmartSystem()	Tests if a device enabler system lookup service is supported.
boolean	supportsDeviceEnablerSystem()	Tests if a device enabler system lookup service is supported.
boolean	supportsDeviceEnablerSystemAssignment()	Tests if a device enabler system service is supported.
boolean	supportsInputEnablerAdmin()	Tests if an input enabler administrative service is supported.
boolean	supportsInputEnablerLookup()	Tests if looking up input enablers is supported.
boolean	supportsInputEnablerNotification()	Tests if an input enabler notification service is supported.
boolean	supportsInputEnablerQuery()	Tests if querying input enablers is supported.
boolean	supportsInputEnablerRecordType(Type inputEnablerRecordType)	Tests if the given InputEnabler record type is supported.
boolean	supportsInputEnablerRuleApplication()	Tests if an input enabler rule application service is supported.
boolean	supportsInputEnablerRuleLookup()	Tests if an input enabler rule lookup service is supported.
boolean	supportsInputEnablerSearch()	Tests if searching input enablers is supported.
boolean	supportsInputEnablerSearchRecordType(Type inputEnablerSearchRecordType)	Tests if the given InputEnabler search record type is supported.
boolean	supportsInputEnablerSmartSystem()	Tests if an input enabler system lookup service is supported.
boolean	supportsInputEnablerSystem()	Tests if an input enabler system lookup service is supported.
boolean	supportsInputEnablerSystemAssignment()	Tests if an input enabler system service is supported.
boolean	supportsTriggerEnablerAdmin()	Tests if a trigger enabler administrative service is supported.
boolean	supportsTriggerEnablerLookup()	Tests if looking up trigger enablers is supported.
boolean	supportsTriggerEnablerNotification()	Tests if a trigger enabler notification service is supported.
boolean	supportsTriggerEnablerQuery()	Tests if querying trigger enablers is supported.
boolean	supportsTriggerEnablerRecordType(Type triggerEnablerRecordType)	Tests if the given TriggerEnabler record type is supported.
boolean	supportsTriggerEnablerRuleApplication()	Tests if a trigger enabler rule application service is supported.
boolean	supportsTriggerEnablerRuleLookup()	Tests if a trigger enabler rule lookup service is supported.
boolean	supportsTriggerEnablerSearch()	Tests if searching trigger enablers is supported.
boolean	supportsTriggerEnablerSearchRecordType(Type triggerEnablerSearchRecordType)	Tests if the given TriggerEnabler search record type is supported.
boolean	supportsTriggerEnablerSmartSystem()	Tests if a trigger enabler system lookup service is supported.
boolean	supportsTriggerEnablerSystem()	Tests if a trigger enabler system lookup service is supported.
boolean	supportsTriggerEnablerSystemAssignment()	Tests if a trigger enabler system service is supported.
boolean	supportsVisibleFederation()	Tests if any broker federation is exposed.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsDeviceEnablerLookup()} is {@code 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 {@code supportsDeviceEnablerLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsDeviceEnablerQuery()} is {@code 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 {@code supportsDeviceEnablerQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsDeviceEnablerSearch()} is {@code 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 {@code supportsDeviceEnablerSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsDeviceEnablerAdmin()} is {@code 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 {@code supportsDeviceEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsDeviceEnablerNotification()} is {@code 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 {@code supportsDeviceEnablerNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsDeviceEnablerSystem()} is {@code 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 {@code supportsDeviceEnablerSystemAssignment()} is {@code 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 {@code supportsDeviceEnablerSmartSystem()} is {@code 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 {@code supportsDeviceEnablerRuleLookup()} is {@code 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 {@code supportsDeviceEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsDeviceEnablerRuleApplication()} is {@code 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 {@code supportsDeviceEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInputEnablerLookup()} is {@code 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 {@code supportsInputEnablerLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInputEnablerQuery()} is {@code 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 {@code supportsInputEnablerQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInputEnablerSearch()} is {@code 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 {@code supportsInputEnablerSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInputEnablerAdmin()} is {@code 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 {@code supportsInputEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInputEnablerNotification()} is {@code 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 {@code supportsInputEnablerNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInputEnablerSystem()} is {@code 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 {@code supportsInputEnablerSystemAssignment()} is {@code 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 {@code supportsInputEnablerSmartSystem()} is {@code 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 {@code supportsInputEnablerRuleLookup()} is {@code 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 {@code supportsInputEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInputEnablerRuleApplication()} is {@code 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 {@code supportsInputEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsTriggerEnablerLookup()} is {@code 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 {@code supportsTriggerEnablerLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsTriggerEnablerQuery()} is {@code 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 {@code supportsTriggerEnablerQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsTriggerEnablerSearch()} is {@code 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 {@code supportsTriggerEnablerSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsTriggerEnablerAdmin()} is {@code 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 {@code supportsTriggerEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsTriggerEnablerNotification()} is {@code 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 {@code supportsTriggerEnablerNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsTriggerEnablerSystem()} is {@code 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 {@code supportsTriggerEnablerSystemAssignment()} is {@code 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 {@code supportsTriggerEnablerSmartSystem()} is {@code 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 {@code supportsTriggerEnablerRuleLookup()} is {@code 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 {@code supportsTriggerEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsTriggerEnablerRuleApplication()} is {@code 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 {@code supportsTriggerEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsActionEnablerLookup()} is {@code 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 {@code supportsActionEnablerLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsActionEnablerQuery()} is {@code 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 {@code supportsActionEnablerQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsActionEnablerSearch()} is {@code 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 {@code supportsActionEnablerSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsActionEnablerAdmin()} is {@code 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 {@code supportsActionEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsActionEnablerNotification()} is {@code 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 {@code supportsActionEnablerNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsActionEnablerSystem()} is {@code 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 {@code supportsActionEnablerSystemAssignment()} is {@code 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 {@code supportsActionEnablerSmartSystem()} is {@code 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 {@code supportsActionEnablerRuleLookup()} is {@code 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 {@code supportsActionEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsActionEnablerRuleApplication()} is {@code 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 {@code supportsActionEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .