Interface ControlRulesProfile
- All Superinterfaces:
OsidProfile, Sourceable
- All Known Subinterfaces:
ControlRulesManager, ControlRulesProxyManager
The control rules profile describes the interoperability among control rules services.
-
Method Summary
Modifier and TypeMethodDescriptionGets the supportedActionEnablerrecord types.Gets the supportedActionEnablersearch record types.Gets the supportedDeviceEnablerrecord types.Gets the supportedDeviceEnablersearch record types.Gets the supportedInputEnablerrecord types.Gets the supportedInputEnablersearch record types.Gets the supportedTriggerEnablerrecord types.Gets the supportedTriggerEnablersearch record types.booleanTests if an action enabler administrative service is supported.booleanTests if looking up action enablers is supported.booleanTests if an action enabler notification service is supported.booleanTests if querying action enablers is supported.booleansupportsActionEnablerRecordType(Type actionEnablerRecordType) Tests if the givenActionEnablerrecord type is supported.booleanTests if searching action enablers is supported.booleansupportsActionEnablerSearchRecordType(Type actionEnablerSearchRecordType) Tests if the givenActionEnablersearch record type is supported.booleanTests if an action enabler system lookup service is supported.booleanTests if an action enabler system lookup service is supported.booleanTests if an action enabler system service is supported.booleanTests if a device enabler administrative service is supported.booleanTests if looking up device enablers is supported.booleanTests if a device enabler notification service is supported.booleanTests if querying device enablers is supported.booleansupportsDeviceEnablerRecordType(Type deviceEnablerRecordType) Tests if the givenDeviceEnablerrecord type is supported.booleanTests if searching device enablers is supported.booleansupportsDeviceEnablerSearchRecordType(Type deviceEnablerSearchRecordType) Tests if the givenDeviceEnablersearch record type is supported.booleanTests if a device enabler system lookup service is supported.booleanTests if a device enabler system lookup service is supported.booleanTests if a device enabler system service is supported.booleanTests if an input enabler administrative service is supported.booleanTests if looking up input enablers is supported.booleanTests if an input enabler notification service is supported.booleanTests if querying input enablers is supported.booleansupportsInputEnablerRecordType(Type inputEnablerRecordType) Tests if the givenInputEnablerrecord type is supported.booleanTests if an input enabler rule application service is supported.booleanTests if an input enabler rule lookup service is supported.booleanTests if searching input enablers is supported.booleansupportsInputEnablerSearchRecordType(Type inputEnablerSearchRecordType) Tests if the givenInputEnablersearch record type is supported.booleanTests if an input enabler system lookup service is supported.booleanTests if an input enabler system lookup service is supported.booleanTests if an input enabler system service is supported.booleanTests if a trigger enabler administrative service is supported.booleanTests if looking up trigger enablers is supported.booleanTests if a trigger enabler notification service is supported.booleanTests if querying trigger enablers is supported.booleansupportsTriggerEnablerRecordType(Type triggerEnablerRecordType) Tests if the givenTriggerEnablerrecord type is supported.booleanTests if a trigger enabler rule application service is supported.booleanTests if a trigger enabler rule lookup service is supported.booleanTests if searching trigger enablers is supported.booleansupportsTriggerEnablerSearchRecordType(Type triggerEnablerSearchRecordType) Tests if the givenTriggerEnablersearch record type is supported.booleanTests if a trigger enabler system lookup service is supported.booleanTests if a trigger enabler system lookup service is supported.booleanTests if a trigger enabler system service is supported.booleanTests if any broker federation is exposed.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
supportsVisibleFederation
boolean supportsVisibleFederation()Tests if any broker federation is exposed. Federation is exposed when a specific broker may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of brokers appears as a single broker.- Returns:
trueif visible federation is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsDeviceEnablerLookup
boolean supportsDeviceEnablerLookup()Tests if looking up device enablers is supported.- Returns:
trueif device enabler lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsDeviceEnablerQuery
boolean supportsDeviceEnablerQuery()Tests if querying device enablers is supported.- Returns:
trueif device enabler query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsDeviceEnablerSearch
boolean supportsDeviceEnablerSearch()Tests if searching device enablers is supported.- Returns:
trueif device enabler search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsDeviceEnablerAdmin
boolean supportsDeviceEnablerAdmin()Tests if a device enabler administrative service is supported.- Returns:
trueif device enabler administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsDeviceEnablerNotification
boolean supportsDeviceEnablerNotification()Tests if a device enabler notification service is supported.- Returns:
trueif device enabler notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsDeviceEnablerSystem
boolean supportsDeviceEnablerSystem()Tests if a device enabler system lookup service is supported.- Returns:
trueif a device enabler system lookup service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsDeviceEnablerSystemAssignment
boolean supportsDeviceEnablerSystemAssignment()Tests if a device enabler system service is supported.- Returns:
trueif device enabler system assignment service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsDeviceEnablerSmartSystem
boolean supportsDeviceEnablerSmartSystem()Tests if a device enabler system lookup service is supported.- Returns:
trueif a device enabler system service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsInputEnablerLookup
boolean supportsInputEnablerLookup()Tests if looking up input enablers is supported.- Returns:
trueif input enabler lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsInputEnablerQuery
boolean supportsInputEnablerQuery()Tests if querying input enablers is supported.- Returns:
trueif input enabler query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsInputEnablerSearch
boolean supportsInputEnablerSearch()Tests if searching input enablers is supported.- Returns:
trueif input enabler search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsInputEnablerAdmin
boolean supportsInputEnablerAdmin()Tests if an input enabler administrative service is supported.- Returns:
trueif input enabler administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsInputEnablerNotification
boolean supportsInputEnablerNotification()Tests if an input enabler notification service is supported.- Returns:
trueif input enabler notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsInputEnablerSystem
boolean supportsInputEnablerSystem()Tests if an input enabler system lookup service is supported.- Returns:
trueif an input enabler system lookup service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsInputEnablerSystemAssignment
boolean supportsInputEnablerSystemAssignment()Tests if an input enabler system service is supported.- Returns:
trueif input enabler system assignment service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsInputEnablerSmartSystem
boolean supportsInputEnablerSmartSystem()Tests if an input enabler system lookup service is supported.- Returns:
trueif an input enabler system service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsInputEnablerRuleLookup
boolean supportsInputEnablerRuleLookup()Tests if an input enabler rule lookup service is supported.- Returns:
trueif a processor enabler rule lookup service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsInputEnablerRuleApplication
boolean supportsInputEnablerRuleApplication()Tests if an input enabler rule application service is supported.- Returns:
trueif input enabler rule application service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsTriggerEnablerLookup
boolean supportsTriggerEnablerLookup()Tests if looking up trigger enablers is supported.- Returns:
trueif trigger enabler lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsTriggerEnablerQuery
boolean supportsTriggerEnablerQuery()Tests if querying trigger enablers is supported.- Returns:
trueif trigger enabler query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsTriggerEnablerSearch
boolean supportsTriggerEnablerSearch()Tests if searching trigger enablers is supported.- Returns:
trueif trigger enabler search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsTriggerEnablerAdmin
boolean supportsTriggerEnablerAdmin()Tests if a trigger enabler administrative service is supported.- Returns:
trueif trigger enabler administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsTriggerEnablerNotification
boolean supportsTriggerEnablerNotification()Tests if a trigger enabler notification service is supported.- Returns:
trueif trigger enabler notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsTriggerEnablerSystem
boolean supportsTriggerEnablerSystem()Tests if a trigger enabler system lookup service is supported.- Returns:
trueif a trigger enabler system lookup service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsTriggerEnablerSystemAssignment
boolean supportsTriggerEnablerSystemAssignment()Tests if a trigger enabler system service is supported.- Returns:
trueif trigger enabler system assignment service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsTriggerEnablerSmartSystem
boolean supportsTriggerEnablerSmartSystem()Tests if a trigger enabler system lookup service is supported.- Returns:
trueif a trigger enabler system service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsTriggerEnablerRuleLookup
boolean supportsTriggerEnablerRuleLookup()Tests if a trigger enabler rule lookup service is supported.- Returns:
trueif a trigger enabler rule lookup service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsTriggerEnablerRuleApplication
boolean supportsTriggerEnablerRuleApplication()Tests if a trigger enabler rule application service is supported.- Returns:
trueif trigger enabler rule application service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsActionEnablerLookup
boolean supportsActionEnablerLookup()Tests if looking up action enablers is supported.- Returns:
trueif action enabler lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsActionEnablerQuery
boolean supportsActionEnablerQuery()Tests if querying action enablers is supported.- Returns:
trueif action enabler query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsActionEnablerSearch
boolean supportsActionEnablerSearch()Tests if searching action enablers is supported.- Returns:
trueif action enabler search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsActionEnablerAdmin
boolean supportsActionEnablerAdmin()Tests if an action enabler administrative service is supported.- Returns:
trueif action enabler administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsActionEnablerNotification
boolean supportsActionEnablerNotification()Tests if an action enabler notification service is supported.- Returns:
trueif action enabler notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsActionEnablerSystem
boolean supportsActionEnablerSystem()Tests if an action enabler system lookup service is supported.- Returns:
trueif an action enabler system lookup service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsActionEnablerSystemAssignment
boolean supportsActionEnablerSystemAssignment()Tests if an action enabler system service is supported.- Returns:
trueif action enabler system assignment service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsActionEnablerSmartSystem
boolean supportsActionEnablerSmartSystem()Tests if an action enabler system lookup service is supported.- Returns:
trueif an action enabler system service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
getDeviceEnablerRecordTypes
TypeList getDeviceEnablerRecordTypes()Gets the supportedDeviceEnablerrecord types.- Returns:
- a list containing the supported
DeviceEnablerrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsDeviceEnablerRecordType
Tests if the givenDeviceEnablerrecord type is supported.- Parameters:
deviceEnablerRecordType- aTypeindicating aDeviceEnablerrecord type- Returns:
trueif the given record type is supported,falseotherwise- Throws:
NullArgumentException-deviceEnablerRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getDeviceEnablerSearchRecordTypes
TypeList getDeviceEnablerSearchRecordTypes()Gets the supportedDeviceEnablersearch record types.- Returns:
- a list containing the supported
DeviceEnablersearch record types - Compliance:
mandatory- This method must be implemented.
-
supportsDeviceEnablerSearchRecordType
Tests if the givenDeviceEnablersearch record type is supported.- Parameters:
deviceEnablerSearchRecordType- aTypeindicating aDeviceEnablersearch record type- Returns:
trueif the given search record type is supported,falseotherwise- Throws:
NullArgumentException-deviceEnablerSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getInputEnablerRecordTypes
TypeList getInputEnablerRecordTypes()Gets the supportedInputEnablerrecord types.- Returns:
- a list containing the supported
InputEnablerrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsInputEnablerRecordType
Tests if the givenInputEnablerrecord type is supported.- Parameters:
inputEnablerRecordType- aTypeindicating anInputEnablerrecord type- Returns:
trueif the given record type is supported,falseotherwise- Throws:
NullArgumentException-inputEnablerRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getInputEnablerSearchRecordTypes
TypeList getInputEnablerSearchRecordTypes()Gets the supportedInputEnablersearch record types.- Returns:
- a list containing the supported
InputEnablersearch record types - Compliance:
mandatory- This method must be implemented.
-
supportsInputEnablerSearchRecordType
Tests if the givenInputEnablersearch record type is supported.- Parameters:
inputEnablerSearchRecordType- aTypeindicating anInputEnablersearch record type- Returns:
trueif the given search record type is supported,falseotherwise- Throws:
NullArgumentException-inputEnablerSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getTriggerEnablerRecordTypes
TypeList getTriggerEnablerRecordTypes()Gets the supportedTriggerEnablerrecord types.- Returns:
- a list containing the supported
TriggerEnablerrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsTriggerEnablerRecordType
Tests if the givenTriggerEnablerrecord type is supported.- Parameters:
triggerEnablerRecordType- aTypeindicating aTriggerEnablerrecord type- Returns:
trueif the given record type is supported,falseotherwise- Throws:
NullArgumentException-triggerEnablerRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getTriggerEnablerSearchRecordTypes
TypeList getTriggerEnablerSearchRecordTypes()Gets the supportedTriggerEnablersearch record types.- Returns:
- a list containing the supported
TriggerEnablersearch record types - Compliance:
mandatory- This method must be implemented.
-
supportsTriggerEnablerSearchRecordType
Tests if the givenTriggerEnablersearch record type is supported.- Parameters:
triggerEnablerSearchRecordType- aTypeindicating aTriggerEnablersearch record type- Returns:
trueif the given search record type is supported,falseotherwise- Throws:
NullArgumentException-triggerEnablerSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getActionEnablerRecordTypes
TypeList getActionEnablerRecordTypes()Gets the supportedActionEnablerrecord types.- Returns:
- a list containing the supported
ActionEnablerrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsActionEnablerRecordType
Tests if the givenActionEnablerrecord type is supported.- Parameters:
actionEnablerRecordType- aTypeindicating anActionEnablerrecord type- Returns:
trueif the given record type is supported,falseotherwise- Throws:
NullArgumentException-actionEnablerRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getActionEnablerSearchRecordTypes
TypeList getActionEnablerSearchRecordTypes()Gets the supportedActionEnablersearch record types.- Returns:
- a list containing the supported
ActionEnablersearch record types - Compliance:
mandatory- This method must be implemented.
-
supportsActionEnablerSearchRecordType
Tests if the givenActionEnablersearch record type is supported.- Parameters:
actionEnablerSearchRecordType- aTypeindicating anActionEnablersearch record type- Returns:
trueif the given search record type is supported,falseotherwise- Throws:
NullArgumentException-actionEnablerSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-