Package de.espirit.firstspirit.feature

Interface FeatureInstallOptions

public interface FeatureInstallOptions
Configuration options for initiating the feature installation process via FeatureInstallAgent.installFeature(FeatureInstallOptions). This class provides a set of customizable options to control the behavior of the feature installation process.
Since:
5.2.231104

  • Method Details

    • Builder

      @NotNull static @NotNull FeatureInstallOptions.Builder Builder()
      Obtain a FeatureInstallOptions.Builder instance for streamlined creation of FeatureInstallOptions. This method returns a FeatureInstallOptions.Builder object, which can be used to construct FeatureInstallOptions instances with customizable configuration settings.
      Returns:
      a FeatureInstallOptions.Builder instance for streamlined FeatureInstallOptions creation.
      Since:
      5.2.231104

    • getFeatureFile

      @NotNull @NotNull FeatureFile getFeatureFile()
      Retrieve a FeatureFile object representing a feature that requires installation. This method returns a FeatureFile instance that represents a feature requiring installation. You can use this object to gather information or trigger the installation process for the specified feature.
      Returns:
      a FeatureFile representing a feature which needs to be installed.
      Since:
      5.2.231104

    • getLayerMapper

      @Nullable @Nullable LayerMapper getLayerMapper()
      Retrieve the LayerMapper to be used during feature installation, or null if not specified. This method returns a LayerMapper instance that should be employed during the feature installation process, but it may return null if no specific mapper has been specified.
      Returns:
      a LayerMapper instance for feature installation, or null if not specified.
      Since:
      5.2.231104

    • installFeatureModel

      boolean installFeatureModel()
      Check if a feature model, containing metadata about content transported by the feature, must be created or updated in the target project immediately after the feature installation process. This method returns true if a feature model needs to be created or updated in the target project as part of the installation process, or false if no such action is required.
      Returns:
      true if a feature model must be created or updated, false otherwise.
      Since:
      5.2.231104

    • importIDProviderGIDs

      boolean importIDProviderGIDs()
      Returns true if the GIDs should be imported/updated during the feature installation process.
      Returns:
      true if the GIDs should be imported/updated, false otherwise.
      Since:
      5.2.240102