OeversionInfo.java

/*
** Module   : OeversionInfo.java
** Abstract : Implementation of the builtin class.
**
** Copyright (c) 2019-2024, Golden Code Development Corporation.
**
** -#- -I- --Date-- -------------------------------Description--------------------------------
** 001 CA  20190526 First version, stubs taken by converting the skeleton using FWD.
** 002 CA  20190812 Added LegacyResource annotation.
** 003 CA  20191024 Added method support levels and updated the class support level.
** 004 CA  20200427 Completed runtime - it reports the legacy OE version.  
**                  Restriction for clientType (only 4GLCLIENT and APPSERVER are used).
** 005 CA  20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy
**                  signature.
** 006 CA  20231113 The 'execute' method must be annotated with LegacySignature Type.Execute, and also can be
**                  dropped if is a no-op.
** 007 GBB 20240105 Add for all fields setters, that throw exception as in OE.
*/

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

import com.goldencode.p2j.util.*;

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

import com.goldencode.p2j.ui.LogicalTerminal;

/**
 * Business logic (converted to Java from the 4GL source code
 * in Progress/Lang/OEVersionInfo.cls).
 */
@LegacyResource(resource = "Progress.Lang.OEVersionInfo")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public final class OeversionInfo
extends BaseObject
{
   /** List of supported types in #6417note-129 */
   private character oeclientType = TypeFactory.character();

   /** The maint version of the legacy OE version. */
   private character oemaintVersion = TypeFactory.character();

   /** The major version of the legacy OE version. */
   private character oemajorVersion = TypeFactory.character();

   /** The minor version of the legacy OE version. */
   private character oeminorVersion = TypeFactory.character();

   /**
    * Create a new instance and initialize it.
    * 
    * @param    major
    *           The major version.
    * @param    minor
    *           The minor version.
    * @param    maint
    *           The maint version.
    * @param    clientType
    *           The client type.
    *           
    * @return   A new instance initialized as above.
    */
   public static object<? extends OeversionInfo> newInstance(String major, 
                                                             String minor,
                                                             String maint,
                                                             String clientType)
   {
      object<? extends OeversionInfo> ver = ObjectOps.newInstance(OeversionInfo.class);
      OeversionInfo ref = ver.ref();
      ref.oeclientType.assign(clientType);
      ref.oemajorVersion.assign(major);
      ref.oeminorVersion.assign(minor);
      ref.oemaintVersion.assign(maint);
      
      return ver;
   }

   /**
    * The default constructor, which initializes it with the legacy OE version.
    */
   @LegacySignature(type = Type.CONSTRUCTOR)
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __lang_OeversionInfo_constructor__()
   {
      internalProcedure(this, "__lang_OeversionInfo_constructor__", new Block((Body) () -> 
      {
         __lang_BaseObject_constructor__();
         
         String legacyVer = ServerPropertiesDaemon.getVersion();
         String[] v = legacyVer.split("\\.");
         this.oemajorVersion.assign(v.length >= 1 ? v[0] : null);
         this.oeminorVersion.assign(v.length >= 2 ? v[1] : null);
         this.oemaintVersion.assign(v.length >= 3 ? v[2] : null);
         
         this.oeclientType.assign(SessionUtils.getClientType());
      }));
   }

   /**
    * Get the value of the {@link #oeclientType} field.
    * 
    * @return   See above.
    */
   @LegacySignature(returns = "CHARACTER", type = Type.GETTER, name = "OEClientType")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL_RESTR)
   public character getOeclientType()
   {
      return function(this, "OEClientType", character.class, new Block((Body) () ->
      {
         returnNormal(oeclientType);
      }));
   }

   /**
    * Sets the value of the {@link #oeclientType} field.
    *
    * @param    clientType
    *           The type of the client.
    *          
    * @throws   ErrorConditionException
    *           Setter throws a runtime error in OE.
    */
   @LegacySignature(type = Type.SETTER, name = "OEClientType", parameters =
      {
         @LegacyParameter(name = "var", type = "CHARACTER", mode = "INPUT")
      })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void setOeclientType(character clientType)
   {
      ErrorManager.noRecordOrThrowError(null);
   }
   
   /**
    * Get the value of the {@link #oemaintVersion} field.
    * 
    * @return   See above.
    */
   @LegacySignature(returns = "CHARACTER", type = Type.GETTER, name = "OEMaintVersion")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public character getOemaintVersion()
   {
      return function(this, "OEMaintVersion", character.class, new Block((Body) () -> 
      {
         returnNormal(oemaintVersion);
      }));
   }
   
   /**
    * Sets the value of the {@link #oemaintVersion} field.
    *
    * @param    maintVersion
    *           The main version.
    *
    * @throws   ErrorConditionException
    *           Setter throws a runtime error in OE.
    */
   @LegacySignature(type = Type.SETTER, name = "OEMaintVersion", parameters =
      {
         @LegacyParameter(name = "var", type = "CHARACTER", mode = "INPUT")
      })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void setOemaintVersion(character maintVersion)
   {
      ErrorManager.noRecordOrThrowError(null);
   }

   /**
    * Get the value of the {@link #oemajorVersion} field.
    * 
    * @return   See above.
    */
   @LegacySignature(returns = "CHARACTER", type = Type.GETTER, name = "OEMajorVersion")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public character getOemajorVersion()
   {
      return function(this, "OEMajorVersion", character.class, new Block((Body) () -> 
      {
         returnNormal(oemajorVersion);
      }));
   }

   /**
    * Sets the value of the {@link #oemajorVersion} field.
    *
    * @param    majorVersion
    *           The major version.
    *
    * @throws   ErrorConditionException
    *           Setter throws a runtime error in OE.
    */
   @LegacySignature(type = Type.SETTER, name = "OEMajorVersion", parameters =
      {
         @LegacyParameter(name = "var", type = "CHARACTER", mode = "INPUT")
      })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void setOemajorVersion(character majorVersion)
   {
      ErrorManager.noRecordOrThrowError(null);
   }

   /**
    * Get the value of the {@link #oeminorVersion} field.
    * 
    * @return   See above.
    */
   @LegacySignature(returns = "CHARACTER", type = Type.GETTER, name = "OEMinorVersion")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public character getOeminorVersion()
   {
      return function(this, "OEMinorVersion", character.class, new Block((Body) () -> 
      {
         returnNormal(oeminorVersion);
      }));
   }

   /**
    * Sets the value of the {@link #oemaintVersion} field.
    *
    * @param    minorVersion
    *           The minor version.
    *
    * @throws   ErrorConditionException
    *           Setter throws a runtime error in OE.
    */
   @LegacySignature(type = Type.SETTER, name = "OEMinorVersion", parameters =
      {
         @LegacyParameter(name = "var", type = "CHARACTER", mode = "INPUT")
      })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void setOeminorVersion(character minorVersion)
   {
      ErrorManager.noRecordOrThrowError(null);
   }
}