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

/**
 * CommunicationSourceDetailValue.java
 */

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

import com.echothree.model.data.communication.common.pk.CommunicationSourceDetailPK;

import com.echothree.model.data.communication.server.factory.CommunicationSourceDetailFactory;

import com.echothree.model.data.communication.common.pk.CommunicationSourcePK;
import com.echothree.model.data.communication.common.pk.CommunicationSourceTypePK;

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 CommunicationSourceDetailValue
        extends BaseValue<CommunicationSourceDetailPK>
        implements Cloneable, Serializable {
    
    private CommunicationSourcePK communicationSourcePK;
    private boolean communicationSourcePKHasBeenModified = false;
    private String communicationSourceName;
    private boolean communicationSourceNameHasBeenModified = false;
    private CommunicationSourceTypePK communicationSourceTypePK;
    private boolean communicationSourceTypePKHasBeenModified = 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(CommunicationSourcePK communicationSourcePK, String communicationSourceName, CommunicationSourceTypePK communicationSourceTypePK, Integer sortOrder, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        checkForNull(communicationSourcePK);
        this.communicationSourcePK = communicationSourcePK;
        checkForNull(communicationSourceName);
        this.communicationSourceName = communicationSourceName;
        checkForNull(communicationSourceTypePK);
        this.communicationSourceTypePK = communicationSourceTypePK;
        checkForNull(sortOrder);
        this.sortOrder = sortOrder;
        checkForNull(fromTime);
        this.fromTime = fromTime;
        checkForNull(thruTime);
        this.thruTime = thruTime;
    }
    
    /** Creates a new instance of CommunicationSourceDetailValue */
    public CommunicationSourceDetailValue(CommunicationSourceDetailPK communicationSourceDetailPK, CommunicationSourcePK communicationSourcePK, String communicationSourceName, CommunicationSourceTypePK communicationSourceTypePK, Integer sortOrder, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super(communicationSourceDetailPK);
        constructFields(communicationSourcePK, communicationSourceName, communicationSourceTypePK, sortOrder, fromTime, thruTime);
    }
    
    /** Creates a new instance of CommunicationSourceDetailValue */
    public CommunicationSourceDetailValue(CommunicationSourcePK communicationSourcePK, String communicationSourceName, CommunicationSourceTypePK communicationSourceTypePK, Integer sortOrder, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super();
        constructFields(communicationSourcePK, communicationSourceName, communicationSourceTypePK, sortOrder, fromTime, thruTime);
    }
    
    @Override
    @Nonnull
    public CommunicationSourceDetailFactory getBaseFactoryInstance() {
        return CommunicationSourceDetailFactory.getInstance();
    }
    
    @Override
    @Nonnull
    public CommunicationSourceDetailValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (CommunicationSourceDetailValue)result;
    }
    
    @Override
    @Nonnull
    public CommunicationSourceDetailPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new CommunicationSourceDetailPK(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 + ((communicationSourcePK != null) ? communicationSourcePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((communicationSourceName != null) ? communicationSourceName.hashCode() : 0);
            hashCode = 37 * hashCode + ((communicationSourceTypePK != null) ? communicationSourceTypePK.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() +
                    ", communicationSourcePK=" + getCommunicationSourcePK() +
                    ", communicationSourceName=" + getCommunicationSourceName() +
                    ", communicationSourceTypePK=" + getCommunicationSourceTypePK() +
                    ", 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  CommunicationSourceDetailValue 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 CommunicationSourceDetailValue that) {
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                CommunicationSourcePK thisCommunicationSourcePK = getCommunicationSourcePK();
                CommunicationSourcePK thatCommunicationSourcePK = that.getCommunicationSourcePK();
                
                if(thisCommunicationSourcePK == null) {
                    objectsEqual = objectsEqual && (thatCommunicationSourcePK == null);
                } else {
                    objectsEqual = objectsEqual && thisCommunicationSourcePK.equals(thatCommunicationSourcePK);
                }
            }
            
            if(objectsEqual) {
                String thisCommunicationSourceName = getCommunicationSourceName();
                String thatCommunicationSourceName = that.getCommunicationSourceName();
                
                if(thisCommunicationSourceName == null) {
                    objectsEqual = objectsEqual && (thatCommunicationSourceName == null);
                } else {
                    objectsEqual = objectsEqual && thisCommunicationSourceName.equals(thatCommunicationSourceName);
                }
            }
            
            if(objectsEqual) {
                CommunicationSourceTypePK thisCommunicationSourceTypePK = getCommunicationSourceTypePK();
                CommunicationSourceTypePK thatCommunicationSourceTypePK = that.getCommunicationSourceTypePK();
                
                if(thisCommunicationSourceTypePK == null) {
                    objectsEqual = objectsEqual && (thatCommunicationSourceTypePK == null);
                } else {
                    objectsEqual = objectsEqual && thisCommunicationSourceTypePK.equals(thatCommunicationSourceTypePK);
                }
            }
            
            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 communicationSourcePKHasBeenModified || communicationSourceNameHasBeenModified || communicationSourceTypePKHasBeenModified || sortOrderHasBeenModified || fromTimeHasBeenModified || thruTimeHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        communicationSourcePKHasBeenModified = false;
        communicationSourceNameHasBeenModified = false;
        communicationSourceTypePKHasBeenModified = false;
        sortOrderHasBeenModified = false;
        fromTimeHasBeenModified = false;
        thruTimeHasBeenModified = false;
    }
    
    @Nonnull
    public CommunicationSourcePK getCommunicationSourcePK() {
        return communicationSourcePK;
    }
    
    public void setCommunicationSourcePK(@Nonnull CommunicationSourcePK communicationSourcePK)
            throws PersistenceNotNullException {
        checkForNull(communicationSourcePK);
        
        boolean update = true;
        
        if(this.communicationSourcePK != null) {
            if(this.communicationSourcePK.equals(communicationSourcePK)) {
                update = false;
            }
        } else if(communicationSourcePK == null) {
            update = false;
        }
        
        if(update) {
            this.communicationSourcePK = communicationSourcePK;
            communicationSourcePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getCommunicationSourcePKHasBeenModified() {
        return communicationSourcePKHasBeenModified;
    }
    
    @Nonnull
    public String getCommunicationSourceName() {
        return communicationSourceName;
    }
    
    public void setCommunicationSourceName(@Nonnull String communicationSourceName)
            throws PersistenceNotNullException {
        checkForNull(communicationSourceName);
        
        boolean update = true;
        
        if(this.communicationSourceName != null) {
            if(this.communicationSourceName.equals(communicationSourceName)) {
                update = false;
            }
        } else if(communicationSourceName == null) {
            update = false;
        }
        
        if(update) {
            this.communicationSourceName = communicationSourceName;
            communicationSourceNameHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getCommunicationSourceNameHasBeenModified() {
        return communicationSourceNameHasBeenModified;
    }
    
    @Nonnull
    public CommunicationSourceTypePK getCommunicationSourceTypePK() {
        return communicationSourceTypePK;
    }
    
    public void setCommunicationSourceTypePK(@Nonnull CommunicationSourceTypePK communicationSourceTypePK)
            throws PersistenceNotNullException {
        checkForNull(communicationSourceTypePK);
        
        boolean update = true;
        
        if(this.communicationSourceTypePK != null) {
            if(this.communicationSourceTypePK.equals(communicationSourceTypePK)) {
                update = false;
            }
        } else if(communicationSourceTypePK == null) {
            update = false;
        }
        
        if(update) {
            this.communicationSourceTypePK = communicationSourceTypePK;
            communicationSourceTypePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getCommunicationSourceTypePKHasBeenModified() {
        return communicationSourceTypePKHasBeenModified;
    }
    
    @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;
    }
    
}