# RestLegacyParameter.java

    /*
    ** Module   : RestLegacyParameter.java
    ** Abstract : Defines a parameter for the 4GL code to be invoked, as it appears in the .restoe file.
    **
    ** Copyright (c) 2019-2021, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
    ** 001 CA  20190614 First version.
    ** 002 GES 20200726 Added handle type and input-output mode.
    ** 003 CA  20211112 Added DATASET-HANDLE type.
    */

    /*
    ** This program is free software: you can redistribute it and/or modify
    ** it under the terms of the GNU Affero General Public License as
    ** published by the Free Software Foundation, either version 3 of the
    ** License, or (at your option) any later version.
    **
    ** This program is distributed in the hope that it will be useful,
    ** but WITHOUT ANY WARRANTY; without even the implied warranty of
    ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    ** GNU Affero General Public License for more details.
    **
    ** You may find a copy of the GNU Affero GPL version 3 at the following
    ** location: https://www.gnu.org/licenses/agpl-3.0.en.html
    **
    ** Additional terms under GNU Affero GPL version 3 section 7:
    **
    **   Under Section 7 of the GNU Affero GPL version 3, the following additional
    **   terms apply to the works covered under the License.  These additional terms
    **   are non-permissive additional terms allowed under Section 7 of the GNU
    **   Affero GPL version 3 and may not be removed by you.
    **
    **   0. Attribution Requirement.
    **
    **     You must preserve all legal notices or author attributions in the covered
    **     work or Appropriate Legal Notices displayed by works containing the covered
    **     work.  You may not remove from the covered work any author or developer
    **     credit already included within the covered work.
    **
    **   1. No License To Use Trademarks.
    **
    **     This license does not grant any license or rights to use the trademarks
    **     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
    **     of Golden Code Development Corporation. You are not authorized to use the
    **     name Golden Code, FWD, or the names of any author or contributor, for
    **     publicity purposes without written authorization.
    **
    **   2. No Misrepresentation of Affiliation.
    **
    **     You may not represent yourself as Golden Code Development Corporation or FWD.
    **
    **     You may not represent yourself for publicity purposes as associated with
    **     Golden Code Development Corporation, FWD, or any author or contributor to
    **     the covered work, without written authorization.
    **
    **   3. No Misrepresentation of Source or Origin.
    **
    **     You may not represent the covered work as solely your work.  All modified
    **     versions of the covered work must be marked in a reasonable way to make it
    **     clear that the modified work is not originating from Golden Code Development
    **     Corporation or FWD.  All modified versions must contain the notices of
    **     attribution required in this license.
    */

    package com.goldencode.p2j.pattern;

    import com.goldencode.p2j.util.*;

    /**
     * This maps a legacy parameter configured in the service's <code>.restoe</code> file.
     * The mapping contains the argument's legacy name, type and mode, from nodes named either
     * <code>wsad:Parameter</code> or <code>wsad:ReturnValue</code>
     */
    class RestLegacyParameter
    {
       /** .restoe wsad:Parameter[ordinal] */
       final int ordinal;

       /** .restoe wsad:Name */
       final String name;

       /** .restoe wsad:OrigName */
       private final String origName;

       /** .restoe wsad:Type */
       final String type;

       /** .restoe wsad:Mode */
       final String mode;

       /** .restoe wsad:Parameter[allowUnknown] */
       final boolean allowUnknown;

       public RestLegacyParameter(int     ordinal,
                                  String  name,
                                  String  origName,
                                  int     type,
                                  int     mode,
                                  boolean allowUnknown)
       {
          this.ordinal = ordinal;
          this.name = name;
          this.origName = origName;
          this.allowUnknown = allowUnknown;

          switch (mode)
          {
             case 1:
                this.mode = "I";
                break;
             case 2:
                this.mode = "O";
                break;
             case 3:
                this.mode = "U";
                break;
             default:
                throw new RuntimeException("Unknown parameter mode " + mode + " for " + name + "!");
          }

          // TODO: raw, com-handle, object, rowid, recid - are they supported?
          switch (type)
          {
             case 1:
                this.type = character.class.getSimpleName();
                break;
             case 2:
                this.type = date.class.getSimpleName();
                break;
             case 3:
                this.type = logical.class.getSimpleName();
                break;
             case 4:
                this.type = integer.class.getSimpleName();
                break;
             case 5:
                this.type = decimal.class.getSimpleName();
                break;
             case 10:
                this.type = handle.class.getSimpleName();
                break;
             case 11:
                this.type = memptr.class.getSimpleName();
                break;
             case 13:
                this.type = rowid.class.getSimpleName();
                break;
             case 15:
                this.type = "TABLE";
                break;
             case 18:
                this.type = blob.class.getSimpleName();
                break;
             case 19:
                this.type = clob.class.getSimpleName();
                break;
             case 34:
                this.type = datetime.class.getSimpleName();
                break;
             case 36:
                this.type = "DATASET";
                break;
             case 37:
                this.type = "DATASET-HANDLE";
                break;
             case 39:
                this.type = longchar.class.getSimpleName();
                break;
             case 40:
                this.type = datetimetz.class.getSimpleName();
                break;
             case 41:
                this.type = int64.class.getSimpleName();
                break;
             default:
                throw new RuntimeException("Unknown parameter type " + type + " for " + name + "!");
          }
       }
    }