# RecordState.java

    /*
    ** Module   : RecordState.java
    ** Abstract : Current state of a database record in an application.
    **
    ** Copyright (c) 2019-2022, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------------Description---------------------------------------
    ** 001 ECF 20191001 First revision. Object which tracks DMO state as changes are applied to it.
    ** 002 ECF 20210519 Added TRACKED state to toString.
    **     ECF 20210924 Added DELETING state to toString.
    **     CA  20221109 Implemented runtime for EXCEPT/FIELDS options - only NO-LOCK records are loaded as
    **                  'partial/incomplete'.
    */

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

    /**
     * An instance of this class tracks the state of a particular data model object (DMO) within an
     * application. Each DMO has an instance of this class associated with it. The persistence ORM
     * framework updates the DMO's state using this instance, as a record is created or loaded from
     * the database, and as changes are applied to it.
     * <p>
     * Although the class and its instance variables are publicly accessible, this class is intended
     * to be used only within the FWD persistence framework.
     */
    public final class RecordState
    {
       /** Current state */
       public int state = DmoState.DEFAULT;

       /**
        * Package private, default constructor. Only the persistence framework must instantiate this
        * class.
        */
       RecordState()
       {
       }

       /**
        * Return a string representation of this object's state, primarily for debugging purposes.
        *
        * @return  String representation of this object.
        */
       @Override
       public String toString()
       {
          StringBuilder sb = new StringBuilder("RecordState{");
          if (state == DmoState.DEFAULT)
          {
             sb.append("DEFAULT");
          }
          else
          {
             if ((state & DmoState.NEW) == DmoState.NEW)
             {
                sb.append("NEW ");
             }
             if ((state & DmoState.NOUNDO) == DmoState.NOUNDO)
             {
                sb.append("NOUNDO ");
             }
             if ((state & DmoState.CACHED) == DmoState.CACHED)
             {
                sb.append("CACHED ");
             }
             if ((state & DmoState.STALE) == DmoState.STALE)
             {
                sb.append("STALE ");
             }
             if ((state & DmoState.DELETING) == DmoState.DELETING)
             {
                sb.append("DELETING ");
             }
             if ((state & DmoState.DELETED) == DmoState.DELETED)
             {
                sb.append("DELETED ");
             }
             if ((state & DmoState.INVALID) == DmoState.INVALID)
             {
                sb.append("INVALID ");
             }
             if ((state & DmoState.COPY) == DmoState.COPY)
             {
                sb.append("COPY ");
             }
             if ((state & DmoState.READ) == DmoState.READ)
             {
                sb.append("READ ");
             }
             if ((state & DmoState.CHANGED) == DmoState.CHANGED)
             {
                sb.append("CHANGED ");
             }
             if ((state & DmoState.TRACKED) == DmoState.TRACKED)
             {
                sb.append("TRACKED ");
             }
             if ((state & DmoState.INCOMPLETE) == DmoState.INCOMPLETE)
             {
                sb.append("INCOMPLETE");
             }
          }
          sb.append("}");

          return sb.toString();
       }
    }