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

/**
 * ChainDetailValue.java
 */

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

import com.echothree.model.data.chain.common.pk.ChainDetailPK;

import com.echothree.model.data.chain.server.factory.ChainDetailFactory;

import com.echothree.model.data.chain.common.pk.ChainPK;
import com.echothree.model.data.chain.common.pk.ChainTypePK;
import com.echothree.model.data.sequence.common.pk.SequencePK;

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 ChainDetailValue
        extends BaseValue<ChainDetailPK>
        implements Cloneable, Serializable {
    
    private ChainPK chainPK;
    private boolean chainPKHasBeenModified = false;
    private ChainTypePK chainTypePK;
    private boolean chainTypePKHasBeenModified = false;
    private String chainName;
    private boolean chainNameHasBeenModified = false;
    private SequencePK chainInstanceSequencePK;
    private boolean chainInstanceSequencePKHasBeenModified = false;
    private Boolean isDefault;
    private boolean isDefaultHasBeenModified = false;
    private Integer sortOrder;
    private boolean sortOrderHasBeenModified = false;
    private Long fromTime;
    private boolean fromTimeHasBeenModified = false;
    private Long thruTime;
    private boolean thruTimeHasBeenModified = false;
    
    private transient Integer _hashCode = null;
    private transient String _stringValue = null;
    
    private void constructFields(ChainPK chainPK, ChainTypePK chainTypePK, String chainName, SequencePK chainInstanceSequencePK, Boolean isDefault, Integer sortOrder, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        checkForNull(chainPK);
        this.chainPK = chainPK;
        checkForNull(chainTypePK);
        this.chainTypePK = chainTypePK;
        checkForNull(chainName);
        this.chainName = chainName;
        this.chainInstanceSequencePK = chainInstanceSequencePK;
        checkForNull(isDefault);
        this.isDefault = isDefault;
        checkForNull(sortOrder);
        this.sortOrder = sortOrder;
        checkForNull(fromTime);
        this.fromTime = fromTime;
        checkForNull(thruTime);
        this.thruTime = thruTime;
    }
    
    /** Creates a new instance of ChainDetailValue */
    public ChainDetailValue(ChainDetailPK chainDetailPK, ChainPK chainPK, ChainTypePK chainTypePK, String chainName, SequencePK chainInstanceSequencePK, Boolean isDefault, Integer sortOrder, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super(chainDetailPK);
        constructFields(chainPK, chainTypePK, chainName, chainInstanceSequencePK, isDefault, sortOrder, fromTime, thruTime);
    }
    
    /** Creates a new instance of ChainDetailValue */
    public ChainDetailValue(ChainPK chainPK, ChainTypePK chainTypePK, String chainName, SequencePK chainInstanceSequencePK, Boolean isDefault, Integer sortOrder, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super();
        constructFields(chainPK, chainTypePK, chainName, chainInstanceSequencePK, isDefault, sortOrder, fromTime, thruTime);
    }
    
    @Override
    @Nonnull
    public ChainDetailFactory getBaseFactoryInstance() {
        return ChainDetailFactory.getInstance();
    }
    
    @Override
    @Nonnull
    public ChainDetailValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (ChainDetailValue)result;
    }
    
    @Override
    @Nonnull
    public ChainDetailPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new ChainDetailPK(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 + ((chainPK != null) ? chainPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((chainTypePK != null) ? chainTypePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((chainName != null) ? chainName.hashCode() : 0);
            hashCode = 37 * hashCode + ((chainInstanceSequencePK != null) ? chainInstanceSequencePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((isDefault != null) ? isDefault.hashCode() : 0);
            hashCode = 37 * hashCode + ((sortOrder != null) ? sortOrder.hashCode() : 0);
            hashCode = 37 * hashCode + ((fromTime != null) ? fromTime.hashCode() : 0);
            hashCode = 37 * hashCode + ((thruTime != null) ? thruTime.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    @Nonnull
    public String toString() {
        if(_stringValue == null) {
            _stringValue = "{" + 
                    "entityId=" + getEntityId() +
                    ", chainPK=" + getChainPK() +
                    ", chainTypePK=" + getChainTypePK() +
                    ", chainName=" + getChainName() +
                    ", chainInstanceSequencePK=" + getChainInstanceSequencePK() +
                    ", isDefault=" + getIsDefault() +
                    ", sortOrder=" + getSortOrder() +
                    ", fromTime=" + getFromTime() +
                    ", thruTime=" + getThruTime() +
                    "}";
        }
        return _stringValue;
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(!hasIdentity())
            return false;
        
        if(other instanceof  ChainDetailValue 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 ChainDetailValue that) {
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                ChainPK thisChainPK = getChainPK();
                ChainPK thatChainPK = that.getChainPK();
                
                if(thisChainPK == null) {
                    objectsEqual = objectsEqual && (thatChainPK == null);
                } else {
                    objectsEqual = objectsEqual && thisChainPK.equals(thatChainPK);
                }
            }
            
            if(objectsEqual) {
                ChainTypePK thisChainTypePK = getChainTypePK();
                ChainTypePK thatChainTypePK = that.getChainTypePK();
                
                if(thisChainTypePK == null) {
                    objectsEqual = objectsEqual && (thatChainTypePK == null);
                } else {
                    objectsEqual = objectsEqual && thisChainTypePK.equals(thatChainTypePK);
                }
            }
            
            if(objectsEqual) {
                String thisChainName = getChainName();
                String thatChainName = that.getChainName();
                
                if(thisChainName == null) {
                    objectsEqual = objectsEqual && (thatChainName == null);
                } else {
                    objectsEqual = objectsEqual && thisChainName.equals(thatChainName);
                }
            }
            
            if(objectsEqual) {
                SequencePK thisChainInstanceSequencePK = getChainInstanceSequencePK();
                SequencePK thatChainInstanceSequencePK = that.getChainInstanceSequencePK();
                
                if(thisChainInstanceSequencePK == null) {
                    objectsEqual = objectsEqual && (thatChainInstanceSequencePK == null);
                } else {
                    objectsEqual = objectsEqual && thisChainInstanceSequencePK.equals(thatChainInstanceSequencePK);
                }
            }
            
            if(objectsEqual) {
                Boolean thisIsDefault = getIsDefault();
                Boolean thatIsDefault = that.getIsDefault();
                
                if(thisIsDefault == null) {
                    objectsEqual = objectsEqual && (thatIsDefault == null);
                } else {
                    objectsEqual = objectsEqual && thisIsDefault.equals(thatIsDefault);
                }
            }
            
            if(objectsEqual) {
                Integer thisSortOrder = getSortOrder();
                Integer thatSortOrder = that.getSortOrder();
                
                if(thisSortOrder == null) {
                    objectsEqual = objectsEqual && (thatSortOrder == null);
                } else {
                    objectsEqual = objectsEqual && thisSortOrder.equals(thatSortOrder);
                }
            }
            
            if(objectsEqual) {
                Long thisFromTime = getFromTime();
                Long thatFromTime = that.getFromTime();
                
                if(thisFromTime == null) {
                    objectsEqual = objectsEqual && (thatFromTime == null);
                } else {
                    objectsEqual = objectsEqual && thisFromTime.equals(thatFromTime);
                }
            }
            
            if(objectsEqual) {
                Long thisThruTime = getThruTime();
                Long thatThruTime = that.getThruTime();
                
                if(thisThruTime == null) {
                    objectsEqual = objectsEqual && (thatThruTime == null);
                } else {
                    objectsEqual = objectsEqual && thisThruTime.equals(thatThruTime);
                }
            }
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    @Override
    public boolean hasBeenModified() {
        return chainPKHasBeenModified || chainTypePKHasBeenModified || chainNameHasBeenModified || chainInstanceSequencePKHasBeenModified || isDefaultHasBeenModified || sortOrderHasBeenModified || fromTimeHasBeenModified || thruTimeHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        chainPKHasBeenModified = false;
        chainTypePKHasBeenModified = false;
        chainNameHasBeenModified = false;
        chainInstanceSequencePKHasBeenModified = false;
        isDefaultHasBeenModified = false;
        sortOrderHasBeenModified = false;
        fromTimeHasBeenModified = false;
        thruTimeHasBeenModified = false;
    }
    
    @Nonnull
    public ChainPK getChainPK() {
        return chainPK;
    }
    
    public void setChainPK(@Nonnull ChainPK chainPK)
            throws PersistenceNotNullException {
        checkForNull(chainPK);
        
        boolean update = true;
        
        if(this.chainPK != null) {
            if(this.chainPK.equals(chainPK)) {
                update = false;
            }
        } else if(chainPK == null) {
            update = false;
        }
        
        if(update) {
            this.chainPK = chainPK;
            chainPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getChainPKHasBeenModified() {
        return chainPKHasBeenModified;
    }
    
    @Nonnull
    public ChainTypePK getChainTypePK() {
        return chainTypePK;
    }
    
    public void setChainTypePK(@Nonnull ChainTypePK chainTypePK)
            throws PersistenceNotNullException {
        checkForNull(chainTypePK);
        
        boolean update = true;
        
        if(this.chainTypePK != null) {
            if(this.chainTypePK.equals(chainTypePK)) {
                update = false;
            }
        } else if(chainTypePK == null) {
            update = false;
        }
        
        if(update) {
            this.chainTypePK = chainTypePK;
            chainTypePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getChainTypePKHasBeenModified() {
        return chainTypePKHasBeenModified;
    }
    
    @Nonnull
    public String getChainName() {
        return chainName;
    }
    
    public void setChainName(@Nonnull String chainName)
            throws PersistenceNotNullException {
        checkForNull(chainName);
        
        boolean update = true;
        
        if(this.chainName != null) {
            if(this.chainName.equals(chainName)) {
                update = false;
            }
        } else if(chainName == null) {
            update = false;
        }
        
        if(update) {
            this.chainName = chainName;
            chainNameHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getChainNameHasBeenModified() {
        return chainNameHasBeenModified;
    }
    
    @Nullable
    public SequencePK getChainInstanceSequencePK() {
        return chainInstanceSequencePK;
    }
    
    public void setChainInstanceSequencePK(@Nullable SequencePK chainInstanceSequencePK) {
        boolean update = true;
        
        if(this.chainInstanceSequencePK != null) {
            if(this.chainInstanceSequencePK.equals(chainInstanceSequencePK)) {
                update = false;
            }
        } else if(chainInstanceSequencePK == null) {
            update = false;
        }
        
        if(update) {
            this.chainInstanceSequencePK = chainInstanceSequencePK;
            chainInstanceSequencePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getChainInstanceSequencePKHasBeenModified() {
        return chainInstanceSequencePKHasBeenModified;
    }
    
    @Nonnull
    public Boolean getIsDefault() {
        return isDefault;
    }
    
    public void setIsDefault(@Nonnull Boolean isDefault)
            throws PersistenceNotNullException {
        checkForNull(isDefault);
        
        boolean update = true;
        
        if(this.isDefault != null) {
            if(this.isDefault.equals(isDefault)) {
                update = false;
            }
        } else if(isDefault == null) {
            update = false;
        }
        
        if(update) {
            this.isDefault = isDefault;
            isDefaultHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getIsDefaultHasBeenModified() {
        return isDefaultHasBeenModified;
    }
    
    @Nonnull
    public Integer getSortOrder() {
        return sortOrder;
    }
    
    public void setSortOrder(@Nonnull Integer sortOrder)
            throws PersistenceNotNullException {
        checkForNull(sortOrder);
        
        boolean update = true;
        
        if(this.sortOrder != null) {
            if(this.sortOrder.equals(sortOrder)) {
                update = false;
            }
        } else if(sortOrder == null) {
            update = false;
        }
        
        if(update) {
            this.sortOrder = sortOrder;
            sortOrderHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getSortOrderHasBeenModified() {
        return sortOrderHasBeenModified;
    }
    
    @Nonnull
    public Long getFromTime() {
        return fromTime;
    }
    
    public void setFromTime(@Nonnull Long fromTime)
            throws PersistenceNotNullException {
        checkForNull(fromTime);
        
        boolean update = true;
        
        if(this.fromTime != null) {
            if(this.fromTime.equals(fromTime)) {
                update = false;
            }
        } else if(fromTime == null) {
            update = false;
        }
        
        if(update) {
            this.fromTime = fromTime;
            fromTimeHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getFromTimeHasBeenModified() {
        return fromTimeHasBeenModified;
    }
    
    @Nonnull
    public Long getThruTime() {
        return thruTime;
    }
    
    public void setThruTime(@Nonnull Long thruTime)
            throws PersistenceNotNullException {
        checkForNull(thruTime);
        
        boolean update = true;
        
        if(this.thruTime != null) {
            if(this.thruTime.equals(thruTime)) {
                update = false;
            }
        } else if(thruTime == null) {
            update = false;
        }
        
        if(update) {
            this.thruTime = thruTime;
            thruTimeHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getThruTimeHasBeenModified() {
        return thruTimeHasBeenModified;
    }
    
}