LegacyJavaAppserverParameter.java

/*
** Module   : LegacyJavaAppserverParameter.java
** Abstract : Parameter configuration, when used by a remote side.
**
** Copyright (c) 2019-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 CA  20190717 Created initial version.
** 002 CA  20230712 Allow setting the 'orig' field, useful when mocking the FWD server when sub-classing
**                  LegacyJavaAppserverClient.
*/

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

/**
 * Parameter configuration when used by a remote side, as a replace for JavaOpenClient API.
 */
public class LegacyJavaAppserverParameter
{
   /** The parameter's numeric type, {@link LegacyJavaAppserverApi} constants. */
   private final int type;

   /** The parameter's numeric mode, {@link LegacyJavaAppserverApi} constants. */
   private final int mode;
   
   /** The parameter's value.  This will reflect back any OUTPUT or INPUT-OUTPUT argument. */
   private Object value;

   /** The parameter's original value. */
   private Object orig;

   /**
    * Configure a new parameter.
    * @param    type
    *           The parameter's type.
    * @param    mode
    *           The parameter's mode.
    * @param    value
    *           The parameter's value.
    * @param    orig
    *           The parameter's original value.
    */
   public LegacyJavaAppserverParameter(int type, int mode, Object value, Object orig)
   {
      this.type = type;
      this.mode = mode;
      this.value = value;
      this.orig = orig;
   }
   
   /**
    * Get the parameter's type.
    * 
    * @return   The {@link #type}.
    */
   public int getType()
   {
      return type;
   }
   
   /**
    * Get the parameter's mode.
    * 
    * @return   The {@link #mode}.
    */
   public int getMode()
   {
      return mode;
   }
   
   /**
    * Get the parameter's value.
    * 
    * @return   The {@link #value}.
    */
   public Object getValue()
   {
      return value;
   }
   
   /**
    * Get the parameter's original value.
    * 
    * @return   The {@link #orig original value}.
    */
   public Object getOrig()
   {
      return orig;
   }

   /**
    * Set the {@link #orig} value.
    * 
    * @param    orig
    *           The parameter's original value.
    */
   void setOrig(Object orig)
   {
      this.orig = orig;
   }

   /**
    * Set the parameter's value as received back from the remote call.
    * 
    * @param    value
    *           The OUTPUT or INPUT-OUTPUT value.
    */
   void setValue(Object value)
   {
      this.value = value;
   }
}