org.eclipse.scout.sdk.core.s/src/main/java/org/eclipse/scout/sdk/core/s/ISdkProperties.java

/*
 * Copyright (c) 2010-2020 BSI Business Systems Integration AG.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     BSI Business Systems Integration AG - initial API and implementation
 */
package org.eclipse.scout.sdk.core.s;

import org.eclipse.scout.sdk.core.builder.IBuilderContext;

/**
 * Defaults used for scout objects
 */
public interface ISdkProperties {
  String SUFFIX_FORM_FIELD = "Field";
  String SUFFIX_LOOKUP_CALL = "LookupCall";
  String SUFFIX_FORM = "Form";
  String SUFFIX_PAGE_WITH_TABLE = "TablePage";
  String SUFFIX_PAGE_WITH_NODES = "NodePage";
  String SUFFIX_DTO = "Data";
  String SUFFIX_DTO_PROPERTY = "Property";
  String SUFFIX_BUTTON = "Button";
  String SUFFIX_TABLE_COLUMN = "Column";
  String SUFFIX_OUTLINE_PAGE = "Page";
  String SUFFIX_FORM_HANDLER = "Handler";
  String SUFFIX_COMPOSITE_FIELD = "Box";
  String SUFFIX_MENU = "Menu";
  String SUFFIX_KEY_STROKE = "KeyStroke";
  String SUFFIX_CODE = "Code";
  String SUFFIX_COLUMN = "Column";
  String SUFFIX_EXTENSION = "Extension";
  String SUFFIX_CALENDAR_ITEM_PROVIDER = "Provider";
  String SUFFIX_SERVICE = "Service";
  String SUFFIX_PERMISSION = "Permission";
  String SUFFIX_CODE_TYPE = "CodeType";
  String SUFFIX_TEST = "Test";
  String SUFFIX_WS_CLIENT = "WebServiceClient";
  String SUFFIX_WS_PROVIDER = "WebService";
  String SUFFIX_WS_URL_PROPERTY = "WebServiceUrlProperty";
  String SUFFIX_WS_PORT_TYPE = "PortType";
  String SUFFIX_WS_SERVICE = "Service";
  String SUFFIX_WS_ENTRY_POINT = "WebServiceEntryPoint";
  String SUFFIX_WS_ENTRY_POINT_DEFINITION = SUFFIX_WS_ENTRY_POINT + "Definition";

  String PREFIX_ABSTRACT = "Abstract";

  String INNER_TABLE_TYPE_NAME = "Table";
  String INNER_TREE_TYPE_NAME = "Tree";
  String INNER_CALENDAR_TYPE_NAME = "Calendar";

  /**
   * Context property for the java project module that is used to resolve imports and in which the source of the generator will be stored.
   * @see IBuilderContext#properties()
   */
  String CONTEXT_PROPERTY_JAVA_PROJECT = "JavaProject";

  /**
   * Context property for the absolute target {@link java.nio.file.Path} in which the source of the generator will be stored.<br>
   *   This might be the exact path to the target file or a parent folder of the file (if the exact target file is not yet known).
   * @see IBuilderContext#properties()
   */
  String CONTEXT_PROPERTY_TARGET_PATH = "TargetPath";

  /**
   * The default view order.
   * <p>
   * Must match the default order number used in the Scout runtime. See
   * org.eclipse.scout.rt.platform.IOrdered.DEFAULT_ORDER
   */
  double DEFAULT_VIEW_ORDER = 98_765_432_123_456_789.0;

  /**
   * The default bean order if no @Order annotation is present (according to the Scout Runtime)
   */
  double DEFAULT_BEAN_ORDER = 5000.0;

  /**
   * Value to add to view orders for new elements.
   */
  int VIEW_ORDER_ANNOTATION_VALUE_STEP = 1000;

}