Interface CharonKbDeterminationFacade

  • All Known Implementing Classes:
    CharonKbDeterminationFacadeImpl

    public interface CharonKbDeterminationFacade
    Wraps the service calls for KB determination. Implementation details (usage of charon) should be hidden from the configuration provider
    • Method Detail

      • hasKbForDate

        boolean hasKbForDate​(java.lang.String productcode,
                             java.util.Date kbdate)
        Check for knowledge bases on a given date
        Parameters:
        productcode - Product code
        kbdate - Validity date
        Returns:
        Does at least one knowledge base exist?
      • hasKbForExtConfig

        @Deprecated(since="1808",
                    forRemoval=true)
        default boolean hasKbForExtConfig​(java.lang.String productcode,
                                          java.lang.String externalcfg)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 18.08.0 - please use parseKBKeyFromExtConfig(String, String) and hasKBForKey(KBKey) instead
        Checks for knowledge base for a given external configuration
        Parameters:
        productcode - product code
        externalcfg - external representation of the configuration
        Returns:
        Does a knowledge base exist for the name, version and logical system specified in the external configuration?
      • readKbIdForDate

        java.lang.Integer readKbIdForDate​(java.lang.String productcode,
                                          java.util.Date kbdate)
        Reads KB ID for a given product and date. It's not required that the KB for the product/date combination is unique, if multiple knowledge bases exist, the ID for the first found KB is returned
        Parameters:
        productcode - product code
        kbdate - Validity date of KB
        Returns:
        KB ID for first matching KB
      • getCurrentKbIdForProduct

        default java.lang.Integer getCurrentKbIdForProduct​(java.lang.String productcode)
        Reads the current KB ID for a given product.
        Parameters:
        productcode - product code
        Returns:
        KB ID for matching KB
      • parseKBKeyFromExtConfig

        KBKey parseKBKeyFromExtConfig​(java.lang.String productCode,
                                      java.lang.String externalcfg)
        parses a KBKey from the external configuration
        Parameters:
        productCode - productCode
        externalcfg - extConfig
        Returns:
        KBKey with all fields filled
      • hasKBForKey

        boolean hasKBForKey​(KBKey kbKey)
        checks the given key for existence
        Parameters:
        kbKey - key to check
        Returns:
        true, only if the given KBKey is known by the configuration engine
      • hasValidKBForKey

        boolean hasValidKBForKey​(KBKey kbKey)
        checks the given key existence and validity
        Parameters:
        kbKey - key to check
        Returns:
        true, only if the given KBKey is known by the configuration engine and valid as of today