Interface IInfobaseSynchronizationSettings


  • public interface IInfobaseSynchronizationSettings
    Describes a synchronization settings of the infobase connection. Infobase synchronization settings are defined by extensions. An infobase synchronization settings extension is defined in plugin.xml.

    Following is an example definition of an infobase synchronization settings extension:

     <extension point="com._1c.g5.v8.dt.platform.services.core.infobaseSynchronizationSettings">
       <settings
         id="com._1c.g5.v8.dt.platform.services.core.synchronizationSettings.ExampleSettings"
         connectionTypeId="com._1c.g5.v8.dt.platform.services.core.infobaseConnection.ExampleConnection"
         strategyTypeId="com._1c.g5.v8.dt.platform.services.core.synchronizationStrategy.ExampleStrategy"
         name="Example synchronization settings"
         description="This settings will use Example Connection and Example strategy">
       </settings>
     </extension>
     

    Describes settings of the synchronization process between project and infobase:

    • Synchronization strategy type identifier
    • Infobase connection type identifier
    • Settings name and description (will be used for settings selection in UI of the DT IDE)

    Registered settings will be available to be selected by the user of DT IDE.

    This interface is intended to be implemented and registered by clients. Instances are not intended to be explicitly used by client.

    • Method Detail

      • getConnectionTypeId

        String getConnectionTypeId()
        Returns the infobase connection type identifier. Cannot return null
        Returns:
        the infobase connection type identifier, never null
      • getStrategyTypeId

        String getStrategyTypeId()
        Returns the infobase synchronization strategy type identifier. Cannot return null
        Returns:
        the infobase synchronization strategy type identifier, never null
      • getName

        String getName()
        Returns the localized name of the synchronization settings.
        Returns:
        the localized name of the synchronization settings, never null
      • getDescription

        Optional<String> getDescription()
        Returns the optional localized description of the synchronization settings.
        Returns:
        the optional localized description of the synchronization settings.