org.osid.control.rules

Interface ControlRulesProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

ControlRulesManager, ControlRulesProxyManager

public interface ControlRulesProfile
extends OsidProfile

The control rules profile describes the interoperability among control rules services.

Method Summary

Methods

Modifier and Type	Method and 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 org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

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:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDeviceEnablerLookup

boolean supportsDeviceEnablerLookup()

Tests if looking up device enablers is supported.

Returns:

true if device enabler lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDeviceEnablerQuery

boolean supportsDeviceEnablerQuery()

Tests if querying device enablers is supported.

Returns:

true if device enabler query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDeviceEnablerSearch

boolean supportsDeviceEnablerSearch()

Tests if searching device enablers is supported.

Returns:

true if device enabler search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDeviceEnablerAdmin

boolean supportsDeviceEnablerAdmin()

Tests if a device enabler administrative service is supported.

Returns:

true if device enabler administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDeviceEnablerNotification

boolean supportsDeviceEnablerNotification()

Tests if a device enabler notification service is supported.

Returns:

true if device enabler notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDeviceEnablerSystem

boolean supportsDeviceEnablerSystem()

Tests if a device enabler system lookup service is supported.

Returns:

true if a device enabler system lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDeviceEnablerSystemAssignment

boolean supportsDeviceEnablerSystemAssignment()

Tests if a device enabler system service is supported.

Returns:

true if device enabler system assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDeviceEnablerSmartSystem

boolean supportsDeviceEnablerSmartSystem()

Tests if a device enabler system lookup service is supported.

Returns:

true if a device enabler system service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInputEnablerLookup

boolean supportsInputEnablerLookup()

Tests if looking up input enablers is supported.

Returns:

true if input enabler lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInputEnablerQuery

boolean supportsInputEnablerQuery()

Tests if querying input enablers is supported.

Returns:

true if input enabler query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInputEnablerSearch

boolean supportsInputEnablerSearch()

Tests if searching input enablers is supported.

Returns:

true if input enabler search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInputEnablerAdmin

boolean supportsInputEnablerAdmin()

Tests if an input enabler administrative service is supported.

Returns:

true if input enabler administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInputEnablerNotification

boolean supportsInputEnablerNotification()

Tests if an input enabler notification service is supported.

Returns:

true if input enabler notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInputEnablerSystem

boolean supportsInputEnablerSystem()

Tests if an input enabler system lookup service is supported.

Returns:

true if an input enabler system lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInputEnablerSystemAssignment

boolean supportsInputEnablerSystemAssignment()

Tests if an input enabler system service is supported.

Returns:

true if input enabler system assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInputEnablerSmartSystem

boolean supportsInputEnablerSmartSystem()

Tests if an input enabler system lookup service is supported.

Returns:

true if an input enabler system service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInputEnablerRuleLookup

boolean supportsInputEnablerRuleLookup()

Tests if an input enabler rule lookup service is supported.

Returns:

true if an processor enabler rule lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInputEnablerRuleApplication

boolean supportsInputEnablerRuleApplication()

Tests if an input enabler rule application service is supported.

Returns:

true if input enabler rule application service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsTriggerEnablerLookup

boolean supportsTriggerEnablerLookup()

Tests if looking up trigger enablers is supported.

Returns:

true if trigger enabler lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsTriggerEnablerQuery

boolean supportsTriggerEnablerQuery()

Tests if querying trigger enablers is supported.

Returns:

true if trigger enabler query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsTriggerEnablerSearch

boolean supportsTriggerEnablerSearch()

Tests if searching trigger enablers is supported.

Returns:

true if trigger enabler search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsTriggerEnablerAdmin

boolean supportsTriggerEnablerAdmin()

Tests if a trigger enabler administrative service is supported.

Returns:

true if trigger enabler administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsTriggerEnablerNotification

boolean supportsTriggerEnablerNotification()

Tests if a trigger enabler notification service is supported.

Returns:

true if trigger enabler notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsTriggerEnablerSystem

boolean supportsTriggerEnablerSystem()

Tests if a trigger enabler system lookup service is supported.

Returns:

true if a trigger enabler system lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsTriggerEnablerSystemAssignment

boolean supportsTriggerEnablerSystemAssignment()

Tests if a trigger enabler system service is supported.

Returns:

true if trigger enabler system assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsTriggerEnablerSmartSystem

boolean supportsTriggerEnablerSmartSystem()

Tests if a trigger enabler system lookup service is supported.

Returns:

true if a trigger enabler system service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsTriggerEnablerRuleLookup

boolean supportsTriggerEnablerRuleLookup()

Tests if a trigger enabler rule lookup service is supported.

Returns:

true if a trigger enabler rule lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsTriggerEnablerRuleApplication

boolean supportsTriggerEnablerRuleApplication()

Tests if a trigger enabler rule application service is supported.

Returns:

true if trigger enabler rule application service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActionEnablerLookup

boolean supportsActionEnablerLookup()

Tests if looking up action enablers is supported.

Returns:

true if action enabler lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActionEnablerQuery

boolean supportsActionEnablerQuery()

Tests if querying action enablers is supported.

Returns:

true if action enabler query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActionEnablerSearch

boolean supportsActionEnablerSearch()

Tests if searching action enablers is supported.

Returns:

true if action enabler search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActionEnablerAdmin

boolean supportsActionEnablerAdmin()

Tests if an action enabler administrative service is supported.

Returns:

true if action enabler administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActionEnablerNotification

boolean supportsActionEnablerNotification()

Tests if an action enabler notification service is supported.

Returns:

true if action enabler notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActionEnablerSystem

boolean supportsActionEnablerSystem()

Tests if an action enabler system lookup service is supported.

Returns:

true if an action enabler system lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActionEnablerSystemAssignment

boolean supportsActionEnablerSystemAssignment()

Tests if an action enabler system service is supported.

Returns:

true if action enabler system assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsActionEnablerSmartSystem

boolean supportsActionEnablerSmartSystem()

Tests if an action enabler system lookup service is supported.

Returns:

true if an action enabler system service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getDeviceEnablerRecordTypes

TypeList getDeviceEnablerRecordTypes()

Gets the supported DeviceEnabler record types.

Returns:

a list containing the supported DeviceEnabler record types

Compliance:

mandatory - This method must be implemented.

supportsDeviceEnablerRecordType

boolean supportsDeviceEnablerRecordType(Type deviceEnablerRecordType)

Tests if the given DeviceEnabler record type is supported.

Parameters:

deviceEnablerRecordType - a Type indicating a DeviceEnabler record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - deviceEnablerRecordType is null

Compliance:

mandatory - This method must be implemented.

getDeviceEnablerSearchRecordTypes

TypeList getDeviceEnablerSearchRecordTypes()

Gets the supported DeviceEnabler search record types.

Returns:

a list containing the supported DeviceEnabler search record types

Compliance:

mandatory - This method must be implemented.

supportsDeviceEnablerSearchRecordType

boolean supportsDeviceEnablerSearchRecordType(Type deviceEnablerSearchRecordType)

Tests if the given DeviceEnabler search record type is supported.

Parameters:

deviceEnablerSearchRecordType - a Type indicating a DeviceEnabler search record type

Returns:

true if the given search record type is supported, false otherwise

Throws:

NullArgumentException - deviceEnablerSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getInputEnablerRecordTypes

TypeList getInputEnablerRecordTypes()

Gets the supported InputEnabler record types.

Returns:

a list containing the supported InputEnabler record types

Compliance:

mandatory - This method must be implemented.

supportsInputEnablerRecordType

boolean supportsInputEnablerRecordType(Type inputEnablerRecordType)

Tests if the given InputEnabler record type is supported.

Parameters:

inputEnablerRecordType - a Type indicating an InputEnabler record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - inputEnablerRecordType is null

Compliance:

mandatory - This method must be implemented.

getInputEnablerSearchRecordTypes

TypeList getInputEnablerSearchRecordTypes()

Gets the supported InputEnabler search record types.

Returns:

a list containing the supported InputEnabler search record types

Compliance:

mandatory - This method must be implemented.

supportsInputEnablerSearchRecordType

boolean supportsInputEnablerSearchRecordType(Type inputEnablerSearchRecordType)

Tests if the given InputEnabler search record type is supported.

Parameters:

inputEnablerSearchRecordType - a Type indicating an InputEnabler search record type

Returns:

true if the given search record type is supported, false otherwise

Throws:

NullArgumentException - inputEnablerSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getTriggerEnablerRecordTypes

TypeList getTriggerEnablerRecordTypes()

Gets the supported TriggerEnabler record types.

Returns:

a list containing the supported TriggerEnabler record types

Compliance:

mandatory - This method must be implemented.

supportsTriggerEnablerRecordType

boolean supportsTriggerEnablerRecordType(Type triggerEnablerRecordType)

Tests if the given TriggerEnabler record type is supported.

Parameters:

triggerEnablerRecordType - a Type indicating a TriggerEnabler record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - triggerEnablerRecordType is null

Compliance:

mandatory - This method must be implemented.

getTriggerEnablerSearchRecordTypes

TypeList getTriggerEnablerSearchRecordTypes()

Gets the supported TriggerEnabler search record types.

Returns:

a list containing the supported TriggerEnabler search record types

Compliance:

mandatory - This method must be implemented.

supportsTriggerEnablerSearchRecordType

boolean supportsTriggerEnablerSearchRecordType(Type triggerEnablerSearchRecordType)

Tests if the given TriggerEnabler search record type is supported.

Parameters:

triggerEnablerSearchRecordType - a Type indicating a TriggerEnabler search record type

Returns:

true if the given search record type is supported, false otherwise

Throws:

NullArgumentException - triggerEnablerSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getActionEnablerRecordTypes

TypeList getActionEnablerRecordTypes()

Gets the supported ActionEnabler record types.

Returns:

a list containing the supported ActionEnabler record types

Compliance:

mandatory - This method must be implemented.

supportsActionEnablerRecordType

boolean supportsActionEnablerRecordType(Type actionEnablerRecordType)

Tests if the given ActionEnabler record type is supported.

Parameters:

actionEnablerRecordType - a Type indicating an ActionEnabler record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - actionEnablerRecordType is null

Compliance:

mandatory - This method must be implemented.

getActionEnablerSearchRecordTypes

TypeList getActionEnablerSearchRecordTypes()

Gets the supported ActionEnabler search record types.

Returns:

a list containing the supported ActionEnabler search record types

Compliance:

mandatory - This method must be implemented.

supportsActionEnablerSearchRecordType

boolean supportsActionEnablerSearchRecordType(Type actionEnablerSearchRecordType)

Tests if the given ActionEnabler search record type is supported.

Parameters:

actionEnablerSearchRecordType - a Type indicating an ActionEnabler search record type

Returns:

true if the given search record type is supported, false otherwise

Throws:

NullArgumentException - actionEnablerSearchRecordType is null

Compliance:

mandatory - This method must be implemented.