org.opentcs.guing.common.exchange.ApplicationPortalProviderConfiguration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opentcs-plantoverview-common Show documentation

opentcs-plantoverview-common

There is a newer version: 6.2.0

Show newest version

/**
 * Copyright (c) The openTCS Authors.
 *
 * This program is free software and subject to the MIT license. (For details,
 * see the licensing information (LICENSE.txt) you should have received with
 * this copy of the software.)
 */
package org.opentcs.guing.common.exchange;

import java.util.List;
import org.opentcs.configuration.ConfigurationEntry;
import org.opentcs.util.gui.dialog.ConnectionParamSet;

/**
 * Provides methods to configure the Model Editor and Operations Desk applications.
 */
public interface ApplicationPortalProviderConfiguration {

  @ConfigurationEntry(
      type = "Comma-separated list of \\|\\|",
      description = "Kernel connection bookmarks to be used.",
      changesApplied = ConfigurationEntry.ChangesApplied.ON_APPLICATION_START,
      orderKey = "1_connection_0"
  )
  List connectionBookmarks();

  @ConfigurationEntry(
      type = "Boolean",
      description = {
          "Whether to use the configured bookmarks when connecting to the kernel.",
          "If 'true', the first connection bookmark will be used for the connection attempt.",
          "If 'false', a dialog will be shown to enter connection parameters."},
      changesApplied = ConfigurationEntry.ChangesApplied.INSTANTLY,
      orderKey = "1_connection_1"
  )
  boolean useBookmarksWhenConnecting();
}