# GenericDatabaseTrigger.java

    /*
    ** Module   : GenericDatabaseTrigger.java
    ** Abstract : Abstract class to be extended by generic database triggers.
    **
    ** Copyright (c) 2023, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- -------------------------------- Description --------------------------------
    ** 001 OM  20230920 Created first version.
    */

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

    import com.goldencode.p2j.persist.*;
    import com.goldencode.p2j.util.*;

    /**
     * Abstract class to be extended by a generic database trigger implementation. This class extends the
     * {@link DatabaseTrigger} and restrict the access interface only to the methods which can be called as
     * callback when the triggers are executed:
     * - the methods which are not called are made final and will just report the unexpected call;
     * - the new callback for Assign was added with an empty body.
     */
    public abstract class GenericDatabaseTrigger
    extends DatabaseTrigger<Buffer>
    {
       /**
        * Should be implemented to get a callback for a generic ASSIGN trigger.
        *
        * @param   buf
        *          Buffer which contains the record that triggered the event.
        * @param   oldValueCopy
        *          A copy of the old value that was changed by assign statement. Even if this value
        *          can be overwritten, the change will be lost when exiting the trigger body block.
        * @param   fieldName
        *          The name of the field which have been changed.
        */
       public void assign(Buffer buf, BaseDataType oldValueCopy, character fieldName)
       {
       }

       /**
        * Should be implemented to get a callback for a generic CREATE trigger.
        *
        * @param   buf
        *          Buffer which contains the record which triggered the event.
        */
       @Override
       public void create(Buffer buf)
       {
       }

       /**
        * Should be implemented to get a callback for a generic DELETE trigger.
        *
        * @param   buf
        *          Buffer which contains the record which triggered the event.
        */
       @Override
       public void delete(Buffer buf)
       {
       }

       /**
        * Should be implemented to get a callback for a generic FIND trigger.
        *
        * @param   buf
        *          Buffer which contains the record which triggered the event.
        */
       @Override
       public void find(Buffer buf)
       {
       }

       /**
        * Should be implemented to get a callback for a generic WRITE trigger.
        *
        * @param   newBuf
        *          Buffer which contains the new value of the record which triggered the event.
        * @param   oldBuf
        *          Buffer which contains the old value of the record which triggered the event.
        */
       public void write(Buffer newBuf, Buffer oldBuf)
       {
       }

       /**
        * Disabled. Should NOT be implemented by an ASSIGN trigger.
        *
        * @param   buf
        *          Buffer which contains the record that triggered the event.
        * @param   oldValueCopy
        *          A copy of the old value that was changed by assign statement. Even if this value
        *          can be overwritten, the change will be lost when exiting the trigger body block.
        */
       @Override
       public final void assign(Buffer buf, BaseDataType oldValueCopy)
       {
       }

       /**
        * Disabled. Should NOT be implemented by an ASSIGN trigger.
        *
        * @param   buf
        *          Buffer which contains the record that triggered the event.
        */
       @Override
       public final void assign(Buffer buf)
       {
       }

       /**
        * Disabled. Should NOT be implemented by a SCHEMA ASSIGN trigger with NEW form (no field reference).
        *
        * @param   newVal
        *          The value that triggered the event.
        * @param   oldValueCopy
        *          A copy of the old value that was changed by assign statement. Even if this value
        *          can be overwritten, the change will be lost when exiting the trigger body block.
        */
       @Override
       public final void assign(Undoable newVal, BaseDataType oldValueCopy)
       {
       }

       /**
        * Disabled. Should NOT  be implemented by a SCHEMA ASSIGN trigger with NEW form (no field reference).
        * This overloaded method does not pass in the old value.
        *
        * @param   newVal
        *          The value that triggered the event.
        */
       @Override
       public final void assign(Undoable newVal)
       {
       }

       /**
        * Disabled. Should NOT be implemented by a WRITE trigger without OLD buffer specified.
        *
        * @param   buf
        *          Buffer which contains the record which triggered the event.
        */
       @Override
       public final void write(Buffer buf)
       {
       }

       /**
        * Disabled. Should NOT be implemented by a REPLICATION-CREATE trigger.
        *
        * @param   buf
        *          Buffer which contains the record which triggered the event.
        */
       @Override
       public final void replicationCreate(Buffer buf)
       {
       }

       /**
        * Disabled. Should NOT be implemented by a REPLICATION-DELETE trigger.
        *
        * @param   buf
        *          Buffer which contains the record which triggered the event.
        */
       @Override
       public final void replicationDelete(Buffer buf)
       {
       }

       /**
        * Disabled. Should NOT be implemented by a REPLICATION-WRITE trigger without OLD buffer specified.
        *
        * @param   buf
        *          Buffer which contains the record which triggered the event.
        */
       @Override
       public final void replicationWrite(Buffer buf)
       {
       }

       /**
        * Disabled. Should NOT be implemented by a REPLICATION-WRITE trigger with OLD buffer specified.
        *
        * @param   newBuf
        *          Buffer which contains the new value of the record which triggered the event.
        * @param   oldBuf
        *          Buffer which contains the old value of the record which triggered the event.
        */
       @Override
       public final  void replicationWrite(Buffer newBuf, Buffer oldBuf)
       {
       }
    }