# LobCopyParameter.java

    /*
    ** Module   : LobCopyParameter.java
    ** Abstract : A parameter of a converted COPY-LOB statement.
    **
    ** Copyright (c) 2019-2022, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------------Description---------------------------------------
    ** 001 ECF 20190517 Created initial version.
    ** 002 ECF 20190628 Implemented COPY-LOB runtime.
    ** 003 OM  20210328 Improved copy lob engine and validations.
    **     EVL 20220405 Added method to validate target offset.
    */

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

    /**
     * A parameter of a {@link LobCopy converted COPY-LOB statement}.
     */
    public interface LobCopyParameter
    {
       /** The unknown type of LOB. Its occurrence means something went wrong. */
       public static final int TYPE_UNKNOWN    = 0x00_00;

       /** A marker bit for easy filtering field LOBs. There are only two of them: CLOBs and BLOBs. */
       public static final int TYPE_FIELD_BIT  = 0x01_00;

       /** A marker bit for easy filtering character LOBs. There are only two of them: CLOBs and LONGCHARs. */
       public static final int TYPE_CHAR_BIT   = 0x08_80;

       /** The type identifier for a CLOB field. This contains both the  */
       public static final int TYPE_CLOB       = 0x00_01 | TYPE_FIELD_BIT | TYPE_CHAR_BIT;

       /** The type identifier for a BLOB field. */
       public static final int TYPE_BLOB       = 0x00_02 | TYPE_FIELD_BIT;

       /** The type identifier for a FILE. */
       public static final int TYPE_FILE       = 0x00_10;

       /** The type identifier for a LONGCHAR variable. */
       public static final int TYPE_LONGCHAR   = 0x00_20 | TYPE_CHAR_BIT;

       /** The type identifier for a MEMPTR variable. */
       public static final int TYPE_MEMPTR     = 0x00_40;

       /**
        * Indicate whether this object is a valid large object data type. It is possible to pass a
        * POLY which is not a valid LOB type as a COPY-LOB parameter, and this error must be
        * determined at runtime.
        *
        * @return  {@code true} if valid, else {@code false}. The default implementation assumes
        *          validity; implementors which must handle runtime type verification must override
        *          this method.
        */
       public default boolean isLargeObject()
       {
          return true;
       }

       /**
        * Indicate whether the large object represented by this parameter natively represents
        * encoded character data, as opposed to binary data.
        *
        * @return  {@code true} if character data; {@code false} if binary data.
        */
       public default boolean isCharacterData()
       {
          return false;
       }

       /**
        * Get the code page of this parameter, if any.
        *
        * @return  4GL code page name or {@code null} if parameter represents non-character data.
        */
       public default String getCodePage()
       {
          return null;
       }

       /**
        * Checks if the optional offset is valid.
        *
        * @param   peerType
        *          The type of the source or target peer object.  The error messages are different in some cases.
        *
        * @return  {@code true} if the optional offset is valid.
        */
       public default boolean validateOffset(int peerType)
       {
          return true;
       }

       /**
        * Validate this parameter.
        *
        * @param   peerType
        *          The type of the peer object. The error messages might be different in some cases.
        *
        * @return  {@code true} if validation did not encounter any issue and {@code false} otherwise, when in
        *          NO-ERROR mode and the {@code ErrorConditionException} is not thrown.
        *
        * @throws  ErrorConditionException
        *          if the parameter fails validation and silent error mode is not active.
        */
       public default boolean validate(int peerType)
       {
          return true;
       }

       /**
        * Obtain the type of the object wrapped by this parameter
        *
        * @return  The numerical id of a type declared as one of the TYPE static constants above.
        */
       public int getObjectType();
    }