ParameterOption.java

/*
** Module   : ParameterOption.java
** Abstract : Declares the parameter options for passing complex data structures (TABLEs and
**            DATASETs and their handles).
**
** Copyright (c) 2019-2021, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------Description---------------------------------
** 001 OM  20190522 Created initial version.
** 002 GES 20210430 Added APPEND member.
*/

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

/**
 * This enum declares the parameter passing options for complex data structures (TABLE, DATASET,
 * TABLE-HANDLE and DATASET-HANDLE for both parameter declaration and parameter passing.
 * The enum is used in both {@link com.goldencode.p2j.persist.DataSetParameter} and
 * {@link TableParameter} as an optional parameter in the constructor.
 */
public enum ParameterOption
{
   /**
    * No option specified. Use the default. This is not actually emitted in generated code, only
    * used at runtime to initialize the internal data. 
    */
   NONE,
   
   /** Data is appended instead of being referenced or replaced. */
   APPEND,
   
   /** The structure is passed by reference (see {@code BY-REFERENCE} mode). */
   BY_REFERENCE,
   
   /** The structure is bound (see {@code BIND} mode). */
   BIND,
   
   /** The structure is passed by value (see {@code BY-VALUE} mode). */
   BY_VALUE
}