// --------------------------------------------------------------------------------
// Copyright 2002-2026 Echo Three, LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// --------------------------------------------------------------------------------
// Generated File -- DO NOT EDIT BY HAND
// --------------------------------------------------------------------------------

/**
 * TransactionStatusValue.java
 */

package com.echothree.model.data.accounting.server.value;

import com.echothree.model.data.accounting.common.pk.TransactionStatusPK;

import com.echothree.model.data.accounting.server.factory.TransactionStatusFactory;

import com.echothree.model.data.accounting.common.pk.TransactionPK;

import com.echothree.util.common.exception.PersistenceCloneException;
import com.echothree.util.common.exception.PersistenceNotNullException;

import com.echothree.util.server.persistence.BaseValue;

import java.io.Serializable;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

public class TransactionStatusValue
        extends BaseValue<TransactionStatusPK>
        implements Cloneable, Serializable {
    
    private TransactionPK transactionPK;
    private boolean transactionPKHasBeenModified = false;
    private Integer transactionGlEntrySequence;
    private boolean transactionGlEntrySequenceHasBeenModified = false;
    
    private transient Integer _hashCode = null;
    private transient String _stringValue = null;
    
    private void constructFields(TransactionPK transactionPK, Integer transactionGlEntrySequence)
            throws PersistenceNotNullException {
        checkForNull(transactionPK);
        this.transactionPK = transactionPK;
        checkForNull(transactionGlEntrySequence);
        this.transactionGlEntrySequence = transactionGlEntrySequence;
    }
    
    /** Creates a new instance of TransactionStatusValue */
    public TransactionStatusValue(TransactionStatusPK transactionStatusPK, TransactionPK transactionPK, Integer transactionGlEntrySequence)
            throws PersistenceNotNullException {
        super(transactionStatusPK);
        constructFields(transactionPK, transactionGlEntrySequence);
    }
    
    /** Creates a new instance of TransactionStatusValue */
    public TransactionStatusValue(TransactionPK transactionPK, Integer transactionGlEntrySequence)
            throws PersistenceNotNullException {
        super();
        constructFields(transactionPK, transactionGlEntrySequence);
    }
    
    @Override
    @Nonnull
    public TransactionStatusFactory getBaseFactoryInstance() {
        return TransactionStatusFactory.getInstance();
    }
    
    @Override
    @Nonnull
    public TransactionStatusValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (TransactionStatusValue)result;
    }
    
    @Override
    @Nonnull
    public TransactionStatusPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new TransactionStatusPK(entityId);
        }
        
        return _primaryKey;
    }
    
    private void clearHashAndString() {
        _hashCode = null;
        _stringValue = null;
    }
    
    @Override
    public int hashCode() {
        if(_hashCode == null) {
            int hashCode = 17;
            
            hashCode = 37 * hashCode + ((entityId != null) ? entityId.hashCode() : 0);
            
            hashCode = 37 * hashCode + ((transactionPK != null) ? transactionPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((transactionGlEntrySequence != null) ? transactionGlEntrySequence.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    @Nonnull
    public String toString() {
        if(_stringValue == null) {
            _stringValue = "{" + 
                    "entityId=" + getEntityId() +
                    ", transactionPK=" + getTransactionPK() +
                    ", transactionGlEntrySequence=" + getTransactionGlEntrySequence() +
                    "}";
        }
        return _stringValue;
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(!hasIdentity())
            return false;
        
        if(other instanceof  TransactionStatusValue that) {
            if(!that.hasIdentity())
                return false;
            
            Long thisEntityId = getEntityId();
            Long thatEntityId = that.getEntityId();
            
            boolean objectsEqual = thisEntityId.equals(thatEntityId);
            if(objectsEqual)
                objectsEqual = isIdentical(that);
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    public boolean isIdentical(Object other) {
        if(other instanceof TransactionStatusValue that) {
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                TransactionPK thisTransactionPK = getTransactionPK();
                TransactionPK thatTransactionPK = that.getTransactionPK();
                
                if(thisTransactionPK == null) {
                    objectsEqual = objectsEqual && (thatTransactionPK == null);
                } else {
                    objectsEqual = objectsEqual && thisTransactionPK.equals(thatTransactionPK);
                }
            }
            
            if(objectsEqual) {
                Integer thisTransactionGlEntrySequence = getTransactionGlEntrySequence();
                Integer thatTransactionGlEntrySequence = that.getTransactionGlEntrySequence();
                
                if(thisTransactionGlEntrySequence == null) {
                    objectsEqual = objectsEqual && (thatTransactionGlEntrySequence == null);
                } else {
                    objectsEqual = objectsEqual && thisTransactionGlEntrySequence.equals(thatTransactionGlEntrySequence);
                }
            }
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    @Override
    public boolean hasBeenModified() {
        return transactionPKHasBeenModified || transactionGlEntrySequenceHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        transactionPKHasBeenModified = false;
        transactionGlEntrySequenceHasBeenModified = false;
    }
    
    @Nonnull
    public TransactionPK getTransactionPK() {
        return transactionPK;
    }
    
    public void setTransactionPK(@Nonnull TransactionPK transactionPK)
            throws PersistenceNotNullException {
        checkForNull(transactionPK);
        
        boolean update = true;
        
        if(this.transactionPK != null) {
            if(this.transactionPK.equals(transactionPK)) {
                update = false;
            }
        } else if(transactionPK == null) {
            update = false;
        }
        
        if(update) {
            this.transactionPK = transactionPK;
            transactionPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getTransactionPKHasBeenModified() {
        return transactionPKHasBeenModified;
    }
    
    @Nonnull
    public Integer getTransactionGlEntrySequence() {
        return transactionGlEntrySequence;
    }
    
    public void setTransactionGlEntrySequence(@Nonnull Integer transactionGlEntrySequence)
            throws PersistenceNotNullException {
        checkForNull(transactionGlEntrySequence);
        
        boolean update = true;
        
        if(this.transactionGlEntrySequence != null) {
            if(this.transactionGlEntrySequence.equals(transactionGlEntrySequence)) {
                update = false;
            }
        } else if(transactionGlEntrySequence == null) {
            update = false;
        }
        
        if(update) {
            this.transactionGlEntrySequence = transactionGlEntrySequence;
            transactionGlEntrySequenceHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getTransactionGlEntrySequenceHasBeenModified() {
        return transactionGlEntrySequenceHasBeenModified;
    }
    
}