InputOutputTableHandle.java

/*
** Module   : InputOutputTableHandle.java
** Abstract : INPUT-OUTPUT TABLE-HANDLE parameter support.
**
** Copyright (c) 2013-2022, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description---------------------------------------
** 001 GES 20210430 Created initial version, by moving code from the parent class.
**     CA  20220601 Any TableParameter or DataSetParameter instances at a legacy OO method or constructor call
**                  must be transformed to their mode'ed version, depending on the INPUT, OUTPUT or 
**                  INPUT-OUTPUT mode, and the DATASET-HANDLE, DATASET, TABLE-HANDLE or TABLE versions.
**     CA  20220727 Fixed OO dataset/table parameters (at the method definition and method call) when there is
**                  an APPEND option.
*/

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

import java.util.*;

import com.goldencode.p2j.persist.*;

/**
 * Implements the INPUT-OUTPUT TABLE-HANDLE parameter type. This hard codes the input/output flags and
 * delegates all other processing to the parent class.
 */
public class InputOutputTableHandle
extends TableParameter
{
   /**
    * Create an instance using a buffer.
    *
    * @param    table
    *           Buffer of the wrapped table.
    */
   public InputOutputTableHandle(Temporary table)
   {
      super(table, ParameterOption.NONE);
   }
   
   /**
    * Create an instance using a buffer.
    *
    * @param    table
    *           Buffer of the wrapped table.
    * @param    option
    *           Table parameter option (APPEND, BY-VALUE, BIND or BY-REFERENCE).
    */
   public InputOutputTableHandle(Temporary table, ParameterOption option)
   {
      super(table, option);
   }
   
   /**
    * Create an instance using a buffer.
    *
    * @param    table
    *           Buffer of the wrapped table.
    * @param    options
    *           Table parameter options (APPEND, BY-VALUE, BIND or BY-REFERENCE).
    */
   public InputOutputTableHandle(Temporary table, EnumSet<ParameterOption> options)
   {
      super(table, options);
   }
   
   /**
    * Create an instance.
    *
    * @param    tableHandle
    *           Handle to the wrapped table.
    */
   public InputOutputTableHandle(handle tableHandle)
   {
      super(tableHandle, ParameterOption.NONE);
   }
   
   /**
    * Create an instance.
    *
    * @param    tableHandle
    *           Handle to the wrapped table.
    * @param    option
    *           Table parameter option (APPEND, BY-VALUE, BIND or BY-REFERENCE).
    */
   public InputOutputTableHandle(handle tableHandle, ParameterOption option)
   {
      super(tableHandle, option);
   }
   
   /**
    * Create an instance.
    *
    * @param    tableHandle
    *           Handle to the wrapped table.
    * @param    options
    *           Table parameter options (APPEND, BY-VALUE, BIND or BY-REFERENCE).
    */
   public InputOutputTableHandle(handle tableHandle, EnumSet<ParameterOption> options)
   {
      super(tableHandle, options);
   }
   
   /**
    * Create an instance using a result set (for remote parameters).
    *
    * @param    resultSet
    *           Result set containing input data.
    */
   public InputOutputTableHandle(TableWrapper resultSet)
   {
      super(resultSet, ParameterOption.NONE);
   }
   
   /**
    * Create an instance using a result set (for remote parameters).
    *
    * @param    resultSet
    *           Result set containing input data.
    * @param    option
    *           Table parameter option (APPEND, BY-VALUE, BIND or BY-REFERENCE).
    */
   public InputOutputTableHandle(TableWrapper resultSet, ParameterOption option)
   {
      super(resultSet, option);
   }
   
   /**
    * Create an instance using a buffer.
    *
    * @param    table
    *           Buffer of the wrapped table.
    */
   public InputOutputTableHandle(InputOutputTableParameter table)
   {
      super(table.getTable(), table.getParameterOptions());
   }

   /**
    * Determines if this parameter is INPUT or INPUT-OUTPUT.
    *
    * @return   Always {@code true}.
    */
   @Override
   public boolean isInputMode()
   {
      return true;
   }

   /**
    * Determines if this parameter is OUTPUT or INPUT-OUTPUT.
    *
    * @return   Always {@code true}.
    */
   @Override
   public boolean isOutputMode()
   {
      return true;
   }
}