Interface ConfigurationProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
ConfigurationManager, ConfigurationProxyManager
public interface ConfigurationProfile extends OsidProfile

The ConfigurationProfile describes the profile of the configuration service.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      Tests if federation is visible for this service.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsValueRetrieval

      boolean supportsValueRetrieval()
      Tests for the availability of a configuration value retrieval service.
      Returns:
      true if value retrieval is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsValueLookup

      boolean supportsValueLookup()
      Tests for the availability of a configuration value lookup service.
      Returns:
      true if value lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsValueQuery

      boolean supportsValueQuery()
      Tests for the availability of a configuration value query service.
      Returns:
      true if value query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsValueSearch

      boolean supportsValueSearch()
      Tests for the availability of a configuration value search service.
      Returns:
      true if value search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsValueAdmin

      boolean supportsValueAdmin()
      Tests for the availability of a configuration value administration service.
      Returns:
      true if value administration is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsValueNotification

      boolean supportsValueNotification()
      Tests for the availability of a configuration value notification service.
      Returns:
      true if value notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsParameterLookup

      boolean supportsParameterLookup()
      Tests for the availability of a parameter lookup service.
      Returns:
      true if parameter lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsParameterQuery

      boolean supportsParameterQuery()
      Tests for the availability of a parameter query service.
      Returns:
      true if parameter query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsParameterSearch

      boolean supportsParameterSearch()
      Tests for the availability of a parameter search service.
      Returns:
      true if parameter search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsParameterAdmin

      boolean supportsParameterAdmin()
      Tests for the availability of a parameter update service.
      Returns:
      true if parameter update is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsParameterNotification

      boolean supportsParameterNotification()
      Tests for the availability of a parameter notification service.
      Returns:
      true if parameter notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsParameterConfiguration

      boolean supportsParameterConfiguration()
      Tests for the availability of a service to lookup mappings of parameters to configurations.
      Returns:
      true if parameter configuration is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsParameterConfigurationAssignment

      boolean supportsParameterConfigurationAssignment()
      Tests for the availability of a service to map parameters to configurations.
      Returns:
      true if parameter configuration assignment is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsParameterSmartConfiguration

      boolean supportsParameterSmartConfiguration()
      Tests for the availability of a parameter smart configuration service.
      Returns:
      true if parameter smart configuration service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsConfigurationLookup

      boolean supportsConfigurationLookup()
      Tests for the availability of a configuration lookup service.
      Returns:
      true if configuration lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsConfigurationQuery

      boolean supportsConfigurationQuery()
      Tests for the availability of a configuration query service.
      Returns:
      true if configuration query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsConfigurationSearch

      boolean supportsConfigurationSearch()
      Tests for the availability of a configuration search service.
      Returns:
      true if configuration search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsConfigurationAdmin

      boolean supportsConfigurationAdmin()
      Tests for the availability of a configuration admin service.
      Returns:
      true if configuration admin is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsConfigurationNotification

      boolean supportsConfigurationNotification()
      Tests for the availability of a notification service for subscribing to changes to configurations.
      Returns:
      true if a configuration notification service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsConfigurationHierarchy

      boolean supportsConfigurationHierarchy()
      Tests for the availability of a configuration hierarchy traversal service.
      Returns:
      true if a configuration hierarchy traversal is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsConfigurationHierarchyDesign

      boolean supportsConfigurationHierarchyDesign()
      Tests for the availability of a configuration hierarchy design service.
      Returns:
      true if a configuration hierarchy design is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsConfigurationBatch

      boolean supportsConfigurationBatch()
      Tests for the availability of a configuration batch service.
      Returns:
      true if a configuration batch service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsConfigurationRules

      boolean supportsConfigurationRules()
      Tests for the availability of a configuration rules service.
      Returns:
      true if a configuration rules service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getValueConditionRecordTypes

      TypeList getValueConditionRecordTypes()
      Gets the supported value condition record types.
      Returns:
      a list containing the supported ValueCondition record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsValueConditionRecordType

      boolean supportsValueConditionRecordType(Type valueConditionRecordType)
      Tests if the given ValueCondition record type is supported.
      Parameters:
      valueConditionRecordType - a Type indicating a ValueCondition record type
      Returns:
      true if the given value condition record Type is supported, false otherwise
      Throws:
      NullArgumentException - valueConditionRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getValueRecordTypes

      TypeList getValueRecordTypes()
      Gets all the value record types supported.
      Returns:
      the list of supported value record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsValueRecordType

      boolean supportsValueRecordType(Type valueRecordType)
      Tests if a given value record type is supported.
      Parameters:
      valueRecordType - the value record type
      Returns:
      true if the value record type is supported, false otherwise
      Throws:
      NullArgumentException - valueRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getValueSearchRecordTypes

      TypeList getValueSearchRecordTypes()
      Gets all the value search record types supported.
      Returns:
      the list of supported value search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsValueSearchRecordType

      boolean supportsValueSearchRecordType(Type valueSearchRecordType)
      Tests if a given value search type is supported.
      Parameters:
      valueSearchRecordType - the value search record type
      Returns:
      true if the value search record type is supported, false otherwise
      Throws:
      NullArgumentException - valueSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getParameterRecordTypes

      TypeList getParameterRecordTypes()
      Gets all the parameter record types supported.
      Returns:
      the list of supported parameter record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsParameterRecordType

      boolean supportsParameterRecordType(Type parameterRecordType)
      Tests if a given parameter record type is supported.
      Parameters:
      parameterRecordType - a parameter record type
      Returns:
      true if the parameter record type is supported, false otherwise
      Throws:
      NullArgumentException - parameterRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getParameterSearchRecordTypes

      TypeList getParameterSearchRecordTypes()
      Gets all the parameter search record types supported.
      Returns:
      the list of supported parameter search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsParameterSearchRecordType

      boolean supportsParameterSearchRecordType(Type parameterSearchRecordType)
      Tests if a given parameter search record type is supported.
      Parameters:
      parameterSearchRecordType - the value search type
      Returns:
      true if the parameter search record type is supported, false otherwise
      Throws:
      NullArgumentException - parameterSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getConfigurationRecordTypes

      TypeList getConfigurationRecordTypes()
      Gets all the configuration record types supported.
      Returns:
      the list of supported configuration record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsConfigurationRecordType

      boolean supportsConfigurationRecordType(Type configurationRecordType)
      Tests if a given configuration record type is supported.
      Parameters:
      configurationRecordType - a configuration record type
      Returns:
      true if the configuration record type is supported, false otherwise
      Throws:
      NullArgumentException - configurationRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getConfigurationSearchRecordTypes

      TypeList getConfigurationSearchRecordTypes()
      Gets all the configuration search record types supported.
      Returns:
      the list of supported configuration search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsConfigurationSearchRecordType

      boolean supportsConfigurationSearchRecordType(Type configurationSearchRecordType)
      Tests if a given configuration search record type is supported.
      Parameters:
      configurationSearchRecordType - the configuration search record type
      Returns:
      true if the configuration search record type is support e d, false otherwise
      Throws:
      NullArgumentException - configurationSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.