// --------------------------------------------------------------------------------
// Copyright 2002-2024 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
// --------------------------------------------------------------------------------

/**
 * GlAccountSummaryValue.java
 */

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

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

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

import com.echothree.model.data.accounting.common.pk.GlAccountPK;
import com.echothree.model.data.party.common.pk.PartyPK;
import com.echothree.model.data.period.common.pk.PeriodPK;

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;

public class GlAccountSummaryValue
        extends BaseValue<GlAccountSummaryPK>
        implements Cloneable, Serializable {
    
    private GlAccountPK glAccountPK;
    private boolean glAccountPKHasBeenModified = false;
    private PartyPK groupPartyPK;
    private boolean groupPartyPKHasBeenModified = false;
    private PeriodPK periodPK;
    private boolean periodPKHasBeenModified = false;
    private Long balance;
    private boolean balanceHasBeenModified = false;
    
    private transient Integer _hashCode = null;
    private transient String _stringValue = null;
    
    private void constructFields(GlAccountPK glAccountPK, PartyPK groupPartyPK, PeriodPK periodPK, Long balance)
            throws PersistenceNotNullException {
        checkForNull(glAccountPK);
        this.glAccountPK = glAccountPK;
        checkForNull(groupPartyPK);
        this.groupPartyPK = groupPartyPK;
        checkForNull(periodPK);
        this.periodPK = periodPK;
        checkForNull(balance);
        this.balance = balance;
    }
    
    /** Creates a new instance of GlAccountSummaryValue */
    public GlAccountSummaryValue(GlAccountSummaryPK glAccountSummaryPK, GlAccountPK glAccountPK, PartyPK groupPartyPK, PeriodPK periodPK, Long balance)
            throws PersistenceNotNullException {
        super(glAccountSummaryPK);
        constructFields(glAccountPK, groupPartyPK, periodPK, balance);
    }
    
    /** Creates a new instance of GlAccountSummaryValue */
    public GlAccountSummaryValue(GlAccountPK glAccountPK, PartyPK groupPartyPK, PeriodPK periodPK, Long balance)
            throws PersistenceNotNullException {
        super();
        constructFields(glAccountPK, groupPartyPK, periodPK, balance);
    }
    
   @Override
   public GlAccountSummaryFactory getBaseFactoryInstance() {
        return GlAccountSummaryFactory.getInstance();
    }
    
    @Override
    public GlAccountSummaryValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (GlAccountSummaryValue)result;
    }
    
   @Override
    public GlAccountSummaryPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new GlAccountSummaryPK(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 + ((glAccountPK != null) ? glAccountPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((groupPartyPK != null) ? groupPartyPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((periodPK != null) ? periodPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((balance != null) ? balance.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    public String toString() {
        if(_stringValue == null) {
            StringBuilder stringValue = new StringBuilder("{");
            
            stringValue.append("entityId=").append(getEntityId());
            
            stringValue.append(", glAccountPK=").append(getGlAccountPK());
            stringValue.append(", groupPartyPK=").append(getGroupPartyPK());
            stringValue.append(", periodPK=").append(getPeriodPK());
            stringValue.append(", balance=").append(getBalance());
            
            stringValue.append('}');
            
            _stringValue = stringValue.toString();
        }
        return _stringValue;
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(!hasIdentity())
            return false;
        
        if(other instanceof  GlAccountSummaryValue) {
            GlAccountSummaryValue that = (GlAccountSummaryValue)other;
            
            if(!that.hasIdentity())
                return false;
            
            Long thisEntityId = getEntityId();
            Long thatEntityId = that.getEntityId();
            
            boolean objectsEqual = thisEntityId.equals(thatEntityId);
            if(objectsEqual)
                objectsEqual = objectsEqual && isIdentical(that);
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    public boolean isIdentical(Object other) {
        if(other instanceof GlAccountSummaryValue) {
            GlAccountSummaryValue that = (GlAccountSummaryValue)other;
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                GlAccountPK thisGlAccountPK = getGlAccountPK();
                GlAccountPK thatGlAccountPK = that.getGlAccountPK();
                
                if(thisGlAccountPK == null) {
                    objectsEqual = objectsEqual && (thatGlAccountPK == null);
                } else {
                    objectsEqual = objectsEqual && thisGlAccountPK.equals(thatGlAccountPK);
                }
            }
            
            if(objectsEqual) {
                PartyPK thisGroupPartyPK = getGroupPartyPK();
                PartyPK thatGroupPartyPK = that.getGroupPartyPK();
                
                if(thisGroupPartyPK == null) {
                    objectsEqual = objectsEqual && (thatGroupPartyPK == null);
                } else {
                    objectsEqual = objectsEqual && thisGroupPartyPK.equals(thatGroupPartyPK);
                }
            }
            
            if(objectsEqual) {
                PeriodPK thisPeriodPK = getPeriodPK();
                PeriodPK thatPeriodPK = that.getPeriodPK();
                
                if(thisPeriodPK == null) {
                    objectsEqual = objectsEqual && (thatPeriodPK == null);
                } else {
                    objectsEqual = objectsEqual && thisPeriodPK.equals(thatPeriodPK);
                }
            }
            
            if(objectsEqual) {
                Long thisBalance = getBalance();
                Long thatBalance = that.getBalance();
                
                if(thisBalance == null) {
                    objectsEqual = objectsEqual && (thatBalance == null);
                } else {
                    objectsEqual = objectsEqual && thisBalance.equals(thatBalance);
                }
            }
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    @Override
    public boolean hasBeenModified() {
        return glAccountPKHasBeenModified || groupPartyPKHasBeenModified || periodPKHasBeenModified || balanceHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        glAccountPKHasBeenModified = false;
        groupPartyPKHasBeenModified = false;
        periodPKHasBeenModified = false;
        balanceHasBeenModified = false;
    }
    
    public GlAccountPK getGlAccountPK() {
        return glAccountPK;
    }
    
    public void setGlAccountPK(GlAccountPK glAccountPK)
            throws PersistenceNotNullException {
        checkForNull(glAccountPK);
        
        boolean update = true;
        
        if(this.glAccountPK != null) {
            if(this.glAccountPK.equals(glAccountPK)) {
                update = false;
            }
        } else if(glAccountPK == null) {
            update = false;
        }
        
        if(update) {
            this.glAccountPK = glAccountPK;
            glAccountPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getGlAccountPKHasBeenModified() {
        return glAccountPKHasBeenModified;
    }
    
    public PartyPK getGroupPartyPK() {
        return groupPartyPK;
    }
    
    public void setGroupPartyPK(PartyPK groupPartyPK)
            throws PersistenceNotNullException {
        checkForNull(groupPartyPK);
        
        boolean update = true;
        
        if(this.groupPartyPK != null) {
            if(this.groupPartyPK.equals(groupPartyPK)) {
                update = false;
            }
        } else if(groupPartyPK == null) {
            update = false;
        }
        
        if(update) {
            this.groupPartyPK = groupPartyPK;
            groupPartyPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getGroupPartyPKHasBeenModified() {
        return groupPartyPKHasBeenModified;
    }
    
    public PeriodPK getPeriodPK() {
        return periodPK;
    }
    
    public void setPeriodPK(PeriodPK periodPK)
            throws PersistenceNotNullException {
        checkForNull(periodPK);
        
        boolean update = true;
        
        if(this.periodPK != null) {
            if(this.periodPK.equals(periodPK)) {
                update = false;
            }
        } else if(periodPK == null) {
            update = false;
        }
        
        if(update) {
            this.periodPK = periodPK;
            periodPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getPeriodPKHasBeenModified() {
        return periodPKHasBeenModified;
    }
    
    public Long getBalance() {
        return balance;
    }
    
    public void setBalance(Long balance)
            throws PersistenceNotNullException {
        checkForNull(balance);
        
        boolean update = true;
        
        if(this.balance != null) {
            if(this.balance.equals(balance)) {
                update = false;
            }
        } else if(balance == null) {
            update = false;
        }
        
        if(update) {
            this.balance = balance;
            balanceHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getBalanceHasBeenModified() {
        return balanceHasBeenModified;
    }
    
}