# TempTableInfo.java

    /*
    ** Module   : TempTableInfo.java
    ** Abstract : Implementation of the Progress.Database.TempTableInfo builtin class.
    **
    ** Copyright (c) 2019-2023, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- -------------------------------Description--------------------------------
    ** 001 CA  20190423 Created the first version, by converting the legacy skeleton .cls file and
    **                  using that output.
    ** 002 CA  20190527 Added annotations for property accessors and class event methods.
    **     RFB 20191022 Added LegacyResource annotation
    ** 003 CA  20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy
    **                  signature.
    **     CA  20210609 Updated INPUT/INPUT-OUTPUT parameters to the new approach, where they are explicitly
    **                  initialized at the method's execution, and not at the caller's arguments.
    ** 004 CA  20231113 The 'execute' method must be annotated with LegacySignature Type.Execute, and also can be
    **                  dropped if is a no-op.
    */

    /*
    ** 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.oo.database;

    import com.goldencode.p2j.util.*;
    import com.goldencode.p2j.oo.lang.*;
    import com.goldencode.p2j.security.*;

    import static com.goldencode.p2j.util.BlockManager.*;
    import static com.goldencode.p2j.report.ReportConstants.*;
    import static com.goldencode.p2j.util.InternalEntry.Type;

    /**
     * Business logic (converted to Java from the 4GL source code
     * in Progress/Database/TempTableInfo.cls).
     */
    @LegacyResource(resource = "Progress.Database.TempTableInfo")
    @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_PARTIAL)
    public class TempTableInfo
    extends BaseObject
    {
       private static ContextLocal<logical> archiveIndexStatistics = new ContextLocal<logical>()
       {
          protected logical initialValue()
          {
             return UndoableFactory.logical();
          }
       };

       private static ContextLocal<integer> tempTablePeak = new ContextLocal<integer>()
       {
          protected integer initialValue()
          {
             return UndoableFactory.integer();
          }
       };

       private static ContextLocal<logical> archiveTableStatistics = new ContextLocal<logical>()
       {
          protected logical initialValue()
          {
             return UndoableFactory.logical();
          }
       };

       private static ContextLocal<integer> tempTableCount = new ContextLocal<integer>()
       {
          protected integer initialValue()
          {
             return UndoableFactory.integer();
          }
       };

       @LegacySignature(type = Type.CONSTRUCTOR)
       public void __database_TempTableInfo_constructor__()
       {
          internalProcedure(this, "__database_TempTableInfo_constructor__", new Block((Body) () ->
          {
             __lang_BaseObject_constructor__();
          }));
       }

       @LegacySignature(returns = "LOGICAL", type = Type.GETTER, name = "ArchiveIndexStatistics")
       public static logical getArchiveIndexStatistics()
       {
          ObjectOps.load(TempTableInfo.class);

          return function(TempTableInfo.class, "ArchiveIndexStatistics", logical.class, new Block((Body) () ->
          {
             returnNormal(archiveIndexStatistics.get());
          }));
       }

       @LegacySignature(type = Type.SETTER, name = "ArchiveIndexStatistics", parameters =
       {
          @LegacyParameter(name = "var", type = "LOGICAL", mode = "INPUT")
       })
       public static void setArchiveIndexStatistics(final logical _var)
       {
          ObjectOps.load(TempTableInfo.class);
          logical var = TypeFactory.initInput(_var);

          internalProcedure(TempTableInfo.class, "ArchiveIndexStatistics", new Block((Body) () ->
          {
             archiveIndexStatistics.get().assign(var);
          }));
       }

       @LegacySignature(returns = "INTEGER", type = Type.GETTER, name = "TempTablePeak")
       public static integer getTempTablePeak()
       {
          ObjectOps.load(TempTableInfo.class);

          return function(TempTableInfo.class, "TempTablePeak", integer.class, new Block((Body) () ->
          {
             returnNormal(tempTablePeak.get());
          }));
       }

       @LegacySignature(returns = "LOGICAL", type = Type.GETTER, name = "ArchiveTableStatistics")
       public static logical getArchiveTableStatistics()
       {
          ObjectOps.load(TempTableInfo.class);

          return function(TempTableInfo.class, "ArchiveTableStatistics", logical.class, new Block((Body) () ->
          {
             returnNormal(archiveTableStatistics.get());
          }));
       }

       @LegacySignature(type = Type.SETTER, name = "ArchiveTableStatistics", parameters =
       {
          @LegacyParameter(name = "var", type = "LOGICAL", mode = "INPUT")
       })
       public static void setArchiveTableStatistics(final logical _var)
       {
          ObjectOps.load(TempTableInfo.class);
          logical var = TypeFactory.initInput(_var);

          internalProcedure(TempTableInfo.class, "ArchiveTableStatistics", new Block((Body) () ->
          {
             archiveTableStatistics.get().assign(var);
          }));
       }

       @LegacySignature(returns = "INTEGER", type = Type.GETTER, name = "TempTableCount")
       public static integer getTempTableCount()
       {
          ObjectOps.load(TempTableInfo.class);

          return function(TempTableInfo.class, "TempTableCount", integer.class, new Block((Body) () ->
          {
             returnNormal(tempTableCount.get());
          }));
       }

       @LegacySignature(returns = "LOGICAL", type = Type.METHOD, name = "GetIndexInfoByID", parameters =
       {
          @LegacyParameter(name = "index-id", type = "INTEGER", mode = "INPUT"),
          @LegacyParameter(name = "index-name", type = "CHARACTER", mode = "OUTPUT"),
          @LegacyParameter(name = "proc-name", type = "CHARACTER", mode = "OUTPUT")
       })
       public static logical getIndexInfoById(final integer _indexId, final character _indexName, final character _procName)
       {
          integer indexId = TypeFactory.initInput(_indexId);
          character indexName = TypeFactory.initOutput(_indexName);
          character procName = TypeFactory.initOutput(_procName);

          return function(TempTableInfo.class, "GetIndexInfoByID", logical.class, new Block());
       }

       @LegacySignature(returns = "LOGICAL", type = Type.METHOD, name = "GetIndexInfoByID", parameters =
       {
          @LegacyParameter(name = "index-id", type = "INTEGER", mode = "INPUT"),
          @LegacyParameter(name = "index-name", type = "CHARACTER", mode = "OUTPUT"),
          @LegacyParameter(name = "table-handle", type = "HANDLE", mode = "OUTPUT"),
          @LegacyParameter(name = "proc-name", type = "CHARACTER", mode = "OUTPUT")
       })
       public static logical getIndexInfoById(final integer _indexId, final character _indexName, final handle _tableHandle, final character _procName)
       {
          integer indexId = TypeFactory.initInput(_indexId);
          character indexName = TypeFactory.initOutput(_indexName);
          handle tableHandle = TypeFactory.initOutput(_tableHandle);
          character procName = TypeFactory.initOutput(_procName);

          return function(TempTableInfo.class, "GetIndexInfoByID", logical.class, new Block());
       }

       @LegacySignature(returns = "LOGICAL", type = Type.METHOD, name = "GetTableInfoByID", parameters =
       {
          @LegacyParameter(name = "temp-table-id", type = "INTEGER", mode = "INPUT"),
          @LegacyParameter(name = "table-name", type = "CHARACTER", mode = "OUTPUT"),
          @LegacyParameter(name = "proc-name", type = "CHARACTER", mode = "OUTPUT")
       })
       public static logical getTableInfoById(final integer _tempTableId, final character _tableName, final character _procName)
       {
          integer tempTableId = TypeFactory.initInput(_tempTableId);
          character tableName = TypeFactory.initOutput(_tableName);
          character procName = TypeFactory.initOutput(_procName);

          return function(TempTableInfo.class, "GetTableInfoByID", logical.class, new Block());
       }

       @LegacySignature(returns = "LOGICAL", type = Type.METHOD, name = "GetTableInfoByID", parameters =
       {
          @LegacyParameter(name = "temp-table-id", type = "INTEGER", mode = "INPUT"),
          @LegacyParameter(name = "table-handle", type = "HANDLE", mode = "OUTPUT"),
          @LegacyParameter(name = "proc-name", type = "CHARACTER", mode = "OUTPUT")
       })
       public static logical getTableInfoById(final integer _tempTableId, final handle _tableHandle, final character _procName)
       {
          integer tempTableId = TypeFactory.initInput(_tempTableId);
          handle tableHandle = TypeFactory.initOutput(_tableHandle);
          character procName = TypeFactory.initOutput(_procName);

          return function(TempTableInfo.class, "GetTableInfoByID", logical.class, new Block());
       }

       @LegacySignature(returns = "HANDLE", type = Type.METHOD, name = "GetTableStatHistoryHandle")
       public static handle getTableStatHistoryHandle()
       {
          return function(TempTableInfo.class, "GetTableStatHistoryHandle", handle.class, new Block());
       }

       @LegacySignature(returns = "HANDLE", type = Type.METHOD, name = "GetIndexStatHistoryHandle")
       public static handle getIndexStatHistoryHandle()
       {
          return function(TempTableInfo.class, "GetIndexStatHistoryHandle", handle.class, new Block());
       }

       @LegacySignature(returns = "HANDLE", type = Type.METHOD, name = "GetTableInfoByPosition", parameters =
       {
          @LegacyParameter(name = "element", type = "INTEGER", mode = "INPUT"),
          @LegacyParameter(name = "table-name", type = "CHARACTER", mode = "OUTPUT"),
          @LegacyParameter(name = "proc-name", type = "CHARACTER", mode = "OUTPUT")
       })
       public static handle getTableInfoByPosition(final integer _element, final character _tableName, final character _procName)
       {
          integer element = TypeFactory.initInput(_element);
          character tableName = TypeFactory.initOutput(_tableName);
          character procName = TypeFactory.initOutput(_procName);

          return function(TempTableInfo.class, "GetTableInfoByPosition", handle.class, new Block());
       }

       @LegacySignature(returns = "HANDLE", type = Type.METHOD, name = "GetTableInfoByPosition", parameters =
       {
          @LegacyParameter(name = "element", type = "INTEGER", mode = "INPUT"),
          @LegacyParameter(name = "table-handle", type = "HANDLE", mode = "OUTPUT"),
          @LegacyParameter(name = "proc-name", type = "CHARACTER", mode = "OUTPUT")
       })
       public static handle getTableInfoByPosition(final integer _element, final handle _tableHandle, final character _procName)
       {
          integer element = TypeFactory.initInput(_element);
          handle tableHandle = TypeFactory.initOutput(_tableHandle);
          character procName = TypeFactory.initOutput(_procName);

          return function(TempTableInfo.class, "GetTableInfoByPosition", handle.class, new Block());
       }

       @LegacySignature(returns = "HANDLE", type = Type.METHOD, name = "GetVSTHandle", parameters =
       {
          @LegacyParameter(name = "VST-ID", type = "INTEGER", mode = "INPUT")
       })
       public static handle getVsthandle(final integer _vstId)
       {
          integer vstId = TypeFactory.initInput(_vstId);

          return function(TempTableInfo.class, "GetVSTHandle", handle.class, new Block());
       }
    }