org.osid.configuration.rules

Interface ConfigurationRulesProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

ConfigurationRulesManager, ConfigurationRulesProxyManager

public interface ConfigurationRulesProfile
extends OsidProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getParameterProcessorEnablerRecordTypes() Gets the supported ParameterProcessorEnabler record types.
TypeList	getParameterProcessorEnablerSearchRecordTypes() Gets the supported ParameterProcessorEnabler search record types.
TypeList	getParameterProcessorRecordTypes() Gets the supported ParameterProcessor record types.
TypeList	getParameterProcessorSearchRecordTypes() Gets the supported ParameterProcessor search record types.
TypeList	getValueEnablerRecordTypes() Gets the supported ValueEnabler record types.
TypeList	getValueEnablerSearchRecordTypes() Gets the supported ValueEnabler search record types.
boolean	supportsParameterProcessorAdmin() Tests if a parameter processor administrative service is supported.
boolean	supportsParameterProcessorConfiguration() Tests if a parameter processor configuration lookup service is supported.
boolean	supportsParameterProcessorConfigurationAssignment() Tests if a parameter processor configuration service is supported.
boolean	supportsParameterProcessorEnablerAdmin() Tests if a parameter processor enabler administrative service is supported.
boolean	supportsParameterProcessorEnablerConfiguration() Tests if a parameter processor enabler configuration lookup service is supported.
boolean	supportsParameterProcessorEnablerConfigurationAssignment() Tests if a parameter processor enabler configuration service is supported.
boolean	supportsParameterProcessorEnablerLookup() Tests if looking up parameter processor enablers is supported.
boolean	supportsParameterProcessorEnablerNotification() Tests if a parameter processor enabler notification service is supported.
boolean	supportsParameterProcessorEnablerQuery() Tests if querying parameter processor enablers is supported.
boolean	supportsParameterProcessorEnablerRecordType(Type parameterProcessorEnablerRecordType) Tests if the given ParameterProcessorEnabler record type is supported.
boolean	supportsParameterProcessorEnablerRuleApplication() Tests if a parameter processor enabler rule application service is supported.
boolean	supportsParameterProcessorEnablerRuleLookup() Tests if a parameter processor enabler rule lookup service is supported.
boolean	supportsParameterProcessorEnablerSearch() Tests if searching parameter processor enablers is supported.
boolean	supportsParameterProcessorEnablerSearchRecordType(Type parameterProcessorEnablerSearchRecordType) Tests if the given ParameterProcessorEnabler search record type is supported.
boolean	supportsParameterProcessorEnablerSmartConfiguration() Tests if a parameter processor enabler configuration lookup service is supported.
boolean	supportsParameterProcessorLookup() Tests if looking up parameter processor is supported.
boolean	supportsParameterProcessorNotification() Tests if a parameter processor notification service is supported.
boolean	supportsParameterProcessorQuery() Tests if querying parameter processor is supported.
boolean	supportsParameterProcessorRecordType(Type parameterProcessorRecordType) Tests if the given ParameterProcessor record type is supported.
boolean	supportsParameterProcessorRuleApplication() Tests if a parameter processor rule application service is supported.
boolean	supportsParameterProcessorRuleLookup() Tests if a parameter processor rule lookup service is supported.
boolean	supportsParameterProcessorSearch() Tests if searching parameter processor is supported.
boolean	supportsParameterProcessorSearchRecordType(Type parameterProcessorSearchRecordType) Tests if the given ParameterProcessor search record type is supported.
boolean	supportsParameterProcessorSmartConfiguration() Tests if a parameter processor configuration lookup service is supported.
boolean	supportsValueEnablerAdmin() Tests if a value enabler administrative service is supported.
boolean	supportsValueEnablerConfiguration() Tests if a value enabler configuration lookup service is supported.
boolean	supportsValueEnablerConfigurationAssignment() Tests if a value enabler configuration service is supported.
boolean	supportsValueEnablerLookup() Tests if looking up value enablers is supported.
boolean	supportsValueEnablerNotification() Tests if a value enabler notification service is supported.
boolean	supportsValueEnablerQuery() Tests if querying value enablers is supported.
boolean	supportsValueEnablerRecordType(Type valueEnablerRecordType) Tests if the given ValueEnabler record type is supported.
boolean	supportsValueEnablerRuleApplication() Tests if a value enabler rule application service is supported.
boolean	supportsValueEnablerRuleLookup() Tests if a value enabler rule lookup service is supported.
boolean	supportsValueEnablerSearch() Tests if searching value enablers is supported.
boolean	supportsValueEnablerSearchRecordType(Type valueEnablerSearchRecordType) Tests if the given ValueEnabler search record type is supported.
boolean	supportsValueEnablerSmartConfiguration() Tests if a value enabler configuration lookup 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.

supportsValueEnablerLookup

boolean supportsValueEnablerLookup()

Tests if looking up value enablers is supported.

Returns:

true if value enabler lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsValueEnablerQuery

boolean supportsValueEnablerQuery()

Tests if querying value enablers is supported.

Returns:

true if value enabler query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsValueEnablerSearch

boolean supportsValueEnablerSearch()

Tests if searching value enablers is supported.

Returns:

true if value enabler search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsValueEnablerAdmin

boolean supportsValueEnablerAdmin()

Tests if a value enabler administrative service is supported.

Returns:

true if value enabler administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsValueEnablerNotification

boolean supportsValueEnablerNotification()

Tests if a value enabler notification service is supported.

Returns:

true if value enabler notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsValueEnablerConfiguration

boolean supportsValueEnablerConfiguration()

Tests if a value enabler configuration lookup service is supported.

Returns:

true if a value enabler configuration lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsValueEnablerConfigurationAssignment

boolean supportsValueEnablerConfigurationAssignment()

Tests if a value enabler configuration service is supported.

Returns:

true if value enabler configuration assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsValueEnablerSmartConfiguration

boolean supportsValueEnablerSmartConfiguration()

Tests if a value enabler configuration lookup service is supported.

Returns:

true if a value enabler configuration service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsValueEnablerRuleLookup

boolean supportsValueEnablerRuleLookup()

Tests if a value enabler rule lookup service is supported.

Returns:

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

Compliance:

mandatory - This method must be implemented.

supportsValueEnablerRuleApplication

boolean supportsValueEnablerRuleApplication()

Tests if a value enabler rule application service is supported.

Returns:

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

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorLookup

boolean supportsParameterProcessorLookup()

Tests if looking up parameter processor is supported.

Returns:

true if parameter processor lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorQuery

boolean supportsParameterProcessorQuery()

Tests if querying parameter processor is supported.

Returns:

true if parameter processor query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorSearch

boolean supportsParameterProcessorSearch()

Tests if searching parameter processor is supported.

Returns:

true if parameter processor search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorAdmin

boolean supportsParameterProcessorAdmin()

Tests if a parameter processor administrative service is supported.

Returns:

true if parameter processor administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorNotification

boolean supportsParameterProcessorNotification()

Tests if a parameter processor notification service is supported.

Returns:

true if parameter processor notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorConfiguration

boolean supportsParameterProcessorConfiguration()

Tests if a parameter processor configuration lookup service is supported.

Returns:

true if a parameter processor configuration lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorConfigurationAssignment

boolean supportsParameterProcessorConfigurationAssignment()

Tests if a parameter processor configuration service is supported.

Returns:

true if parameter processor configuration assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorSmartConfiguration

boolean supportsParameterProcessorSmartConfiguration()

Tests if a parameter processor configuration lookup service is supported.

Returns:

true if a parameter processor configuration service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorRuleLookup

boolean supportsParameterProcessorRuleLookup()

Tests if a parameter processor rule lookup service is supported.

Returns:

true if a parameter processor rule lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorRuleApplication

boolean supportsParameterProcessorRuleApplication()

Tests if a parameter processor rule application service is supported.

Returns:

true if parameter processor rule application service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorEnablerLookup

boolean supportsParameterProcessorEnablerLookup()

Tests if looking up parameter processor enablers is supported.

Returns:

true if parameter processor enabler lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorEnablerQuery

boolean supportsParameterProcessorEnablerQuery()

Tests if querying parameter processor enablers is supported.

Returns:

true if parameter processor enabler query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorEnablerSearch

boolean supportsParameterProcessorEnablerSearch()

Tests if searching parameter processor enablers is supported.

Returns:

true if parameter processor enabler search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorEnablerAdmin

boolean supportsParameterProcessorEnablerAdmin()

Tests if a parameter processor enabler administrative service is supported.

Returns:

true if parameter processor enabler administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorEnablerNotification

boolean supportsParameterProcessorEnablerNotification()

Tests if a parameter processor enabler notification service is supported.

Returns:

true if parameter processor enabler notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorEnablerConfiguration

boolean supportsParameterProcessorEnablerConfiguration()

Tests if a parameter processor enabler configuration lookup service is supported.

Returns:

true if a parameter processor enabler configuration lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorEnablerConfigurationAssignment

boolean supportsParameterProcessorEnablerConfigurationAssignment()

Tests if a parameter processor enabler configuration service is supported.

Returns:

true if parameter processor enabler configuration assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorEnablerSmartConfiguration

boolean supportsParameterProcessorEnablerSmartConfiguration()

Tests if a parameter processor enabler configuration lookup service is supported.

Returns:

true if a parameter processor enabler configuration service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorEnablerRuleLookup

boolean supportsParameterProcessorEnablerRuleLookup()

Tests if a parameter processor enabler rule lookup service is supported.

Returns:

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

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorEnablerRuleApplication

boolean supportsParameterProcessorEnablerRuleApplication()

Tests if a parameter processor enabler rule application service is supported.

Returns:

true if parameter processor enabler rule application service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getValueEnablerRecordTypes

TypeList getValueEnablerRecordTypes()

Gets the supported ValueEnabler record types.

Returns:

a list containing the supported ValueEnabler record types

Compliance:

mandatory - This method must be implemented.

supportsValueEnablerRecordType

boolean supportsValueEnablerRecordType(Type valueEnablerRecordType)

Tests if the given ValueEnabler record type is supported.

Parameters:

valueEnablerRecordType - a Type indicating a ValueEnabler record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - valueEnablerRecordType is null

Compliance:

mandatory - This method must be implemented.

getValueEnablerSearchRecordTypes

TypeList getValueEnablerSearchRecordTypes()

Gets the supported ValueEnabler search record types.

Returns:

a list containing the supported ValueEnabler search record types

Compliance:

mandatory - This method must be implemented.

supportsValueEnablerSearchRecordType

boolean supportsValueEnablerSearchRecordType(Type valueEnablerSearchRecordType)

Tests if the given ValueEnabler search record type is supported.

Parameters:

valueEnablerSearchRecordType - a Type indicating a ValueEnabler search record type

Returns:

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

Throws:

NullArgumentException - valueEnablerSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getParameterProcessorRecordTypes

TypeList getParameterProcessorRecordTypes()

Gets the supported ParameterProcessor record types.

Returns:

a list containing the supported ParameterProcessor record types

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorRecordType

boolean supportsParameterProcessorRecordType(Type parameterProcessorRecordType)

Tests if the given ParameterProcessor record type is supported.

Parameters:

parameterProcessorRecordType - a Type indicating a ParameterProcessor record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - parameterProcessorRecordType is null

Compliance:

mandatory - This method must be implemented.

getParameterProcessorSearchRecordTypes

TypeList getParameterProcessorSearchRecordTypes()

Gets the supported ParameterProcessor search record types.

Returns:

a list containing the supported ParameterProcessor search record types

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorSearchRecordType

boolean supportsParameterProcessorSearchRecordType(Type parameterProcessorSearchRecordType)

Tests if the given ParameterProcessor search record type is supported.

Parameters:

parameterProcessorSearchRecordType - a Type indicating a ParameterProcessor search record type

Returns:

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

Throws:

NullArgumentException - parameterProcessorSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getParameterProcessorEnablerRecordTypes

TypeList getParameterProcessorEnablerRecordTypes()

Gets the supported ParameterProcessorEnabler record types.

Returns:

a list containing the supported ParameterProcessorEnabler record types

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorEnablerRecordType

boolean supportsParameterProcessorEnablerRecordType(Type parameterProcessorEnablerRecordType)

Tests if the given ParameterProcessorEnabler record type is supported.

Parameters:

parameterProcessorEnablerRecordType - a Type indicating a ParameterProcessorEnabler record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - parameterProcessorEnablerRecordType is null

Compliance:

mandatory - This method must be implemented.

getParameterProcessorEnablerSearchRecordTypes

TypeList getParameterProcessorEnablerSearchRecordTypes()

Gets the supported ParameterProcessorEnabler search record types.

Returns:

a list containing the supported ParameterProcessorEnabler search record types

Compliance:

mandatory - This method must be implemented.

supportsParameterProcessorEnablerSearchRecordType

boolean supportsParameterProcessorEnablerSearchRecordType(Type parameterProcessorEnablerSearchRecordType)

Tests if the given ParameterProcessorEnabler search record type is supported.

Parameters:

parameterProcessorEnablerSearchRecordType - a Type indicating a ParameterProcessorEnabler search record type

Returns:

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

Throws:

NullArgumentException - parameterProcessorEnablerSearchRecordType is null

Compliance:

mandatory - This method must be implemented.