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

/**
 * LetterContactMechanismPurposeDetailValue.java
 */

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

import com.echothree.model.data.letter.common.pk.LetterContactMechanismPurposeDetailPK;

import com.echothree.model.data.letter.server.factory.LetterContactMechanismPurposeDetailFactory;

import com.echothree.model.data.letter.common.pk.LetterContactMechanismPurposePK;
import com.echothree.model.data.letter.common.pk.LetterPK;
import com.echothree.model.data.contact.common.pk.ContactMechanismPurposePK;

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 LetterContactMechanismPurposeDetailValue
        extends BaseValue<LetterContactMechanismPurposeDetailPK>
        implements Cloneable, Serializable {
    
    private LetterContactMechanismPurposePK letterContactMechanismPurposePK;
    private boolean letterContactMechanismPurposePKHasBeenModified = false;
    private LetterPK letterPK;
    private boolean letterPKHasBeenModified = false;
    private Integer priority;
    private boolean priorityHasBeenModified = false;
    private ContactMechanismPurposePK contactMechanismPurposePK;
    private boolean contactMechanismPurposePKHasBeenModified = 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(LetterContactMechanismPurposePK letterContactMechanismPurposePK, LetterPK letterPK, Integer priority, ContactMechanismPurposePK contactMechanismPurposePK, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        checkForNull(letterContactMechanismPurposePK);
        this.letterContactMechanismPurposePK = letterContactMechanismPurposePK;
        checkForNull(letterPK);
        this.letterPK = letterPK;
        checkForNull(priority);
        this.priority = priority;
        checkForNull(contactMechanismPurposePK);
        this.contactMechanismPurposePK = contactMechanismPurposePK;
        checkForNull(fromTime);
        this.fromTime = fromTime;
        checkForNull(thruTime);
        this.thruTime = thruTime;
    }
    
    /** Creates a new instance of LetterContactMechanismPurposeDetailValue */
    public LetterContactMechanismPurposeDetailValue(LetterContactMechanismPurposeDetailPK letterContactMechanismPurposeDetailPK, LetterContactMechanismPurposePK letterContactMechanismPurposePK, LetterPK letterPK, Integer priority, ContactMechanismPurposePK contactMechanismPurposePK, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super(letterContactMechanismPurposeDetailPK);
        constructFields(letterContactMechanismPurposePK, letterPK, priority, contactMechanismPurposePK, fromTime, thruTime);
    }
    
    /** Creates a new instance of LetterContactMechanismPurposeDetailValue */
    public LetterContactMechanismPurposeDetailValue(LetterContactMechanismPurposePK letterContactMechanismPurposePK, LetterPK letterPK, Integer priority, ContactMechanismPurposePK contactMechanismPurposePK, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super();
        constructFields(letterContactMechanismPurposePK, letterPK, priority, contactMechanismPurposePK, fromTime, thruTime);
    }
    
   @Override
   public LetterContactMechanismPurposeDetailFactory getBaseFactoryInstance() {
        return LetterContactMechanismPurposeDetailFactory.getInstance();
    }
    
    @Override
    public LetterContactMechanismPurposeDetailValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (LetterContactMechanismPurposeDetailValue)result;
    }
    
   @Override
    public LetterContactMechanismPurposeDetailPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new LetterContactMechanismPurposeDetailPK(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 + ((letterContactMechanismPurposePK != null) ? letterContactMechanismPurposePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((letterPK != null) ? letterPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((priority != null) ? priority.hashCode() : 0);
            hashCode = 37 * hashCode + ((contactMechanismPurposePK != null) ? contactMechanismPurposePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((fromTime != null) ? fromTime.hashCode() : 0);
            hashCode = 37 * hashCode + ((thruTime != null) ? thruTime.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    public String toString() {
        if(_stringValue == null) {
            StringBuilder stringValue = new StringBuilder("{");
            
            stringValue.append("entityId=").append(getEntityId());
            
            stringValue.append(", letterContactMechanismPurposePK=").append(getLetterContactMechanismPurposePK());
            stringValue.append(", letterPK=").append(getLetterPK());
            stringValue.append(", priority=").append(getPriority());
            stringValue.append(", contactMechanismPurposePK=").append(getContactMechanismPurposePK());
            stringValue.append(", fromTime=").append(getFromTime());
            stringValue.append(", thruTime=").append(getThruTime());
            
            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  LetterContactMechanismPurposeDetailValue) {
            LetterContactMechanismPurposeDetailValue that = (LetterContactMechanismPurposeDetailValue)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 LetterContactMechanismPurposeDetailValue) {
            LetterContactMechanismPurposeDetailValue that = (LetterContactMechanismPurposeDetailValue)other;
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                LetterContactMechanismPurposePK thisLetterContactMechanismPurposePK = getLetterContactMechanismPurposePK();
                LetterContactMechanismPurposePK thatLetterContactMechanismPurposePK = that.getLetterContactMechanismPurposePK();
                
                if(thisLetterContactMechanismPurposePK == null) {
                    objectsEqual = objectsEqual && (thatLetterContactMechanismPurposePK == null);
                } else {
                    objectsEqual = objectsEqual && thisLetterContactMechanismPurposePK.equals(thatLetterContactMechanismPurposePK);
                }
            }
            
            if(objectsEqual) {
                LetterPK thisLetterPK = getLetterPK();
                LetterPK thatLetterPK = that.getLetterPK();
                
                if(thisLetterPK == null) {
                    objectsEqual = objectsEqual && (thatLetterPK == null);
                } else {
                    objectsEqual = objectsEqual && thisLetterPK.equals(thatLetterPK);
                }
            }
            
            if(objectsEqual) {
                Integer thisPriority = getPriority();
                Integer thatPriority = that.getPriority();
                
                if(thisPriority == null) {
                    objectsEqual = objectsEqual && (thatPriority == null);
                } else {
                    objectsEqual = objectsEqual && thisPriority.equals(thatPriority);
                }
            }
            
            if(objectsEqual) {
                ContactMechanismPurposePK thisContactMechanismPurposePK = getContactMechanismPurposePK();
                ContactMechanismPurposePK thatContactMechanismPurposePK = that.getContactMechanismPurposePK();
                
                if(thisContactMechanismPurposePK == null) {
                    objectsEqual = objectsEqual && (thatContactMechanismPurposePK == null);
                } else {
                    objectsEqual = objectsEqual && thisContactMechanismPurposePK.equals(thatContactMechanismPurposePK);
                }
            }
            
            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 letterContactMechanismPurposePKHasBeenModified || letterPKHasBeenModified || priorityHasBeenModified || contactMechanismPurposePKHasBeenModified || fromTimeHasBeenModified || thruTimeHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        letterContactMechanismPurposePKHasBeenModified = false;
        letterPKHasBeenModified = false;
        priorityHasBeenModified = false;
        contactMechanismPurposePKHasBeenModified = false;
        fromTimeHasBeenModified = false;
        thruTimeHasBeenModified = false;
    }
    
    public LetterContactMechanismPurposePK getLetterContactMechanismPurposePK() {
        return letterContactMechanismPurposePK;
    }
    
    public void setLetterContactMechanismPurposePK(LetterContactMechanismPurposePK letterContactMechanismPurposePK)
            throws PersistenceNotNullException {
        checkForNull(letterContactMechanismPurposePK);
        
        boolean update = true;
        
        if(this.letterContactMechanismPurposePK != null) {
            if(this.letterContactMechanismPurposePK.equals(letterContactMechanismPurposePK)) {
                update = false;
            }
        } else if(letterContactMechanismPurposePK == null) {
            update = false;
        }
        
        if(update) {
            this.letterContactMechanismPurposePK = letterContactMechanismPurposePK;
            letterContactMechanismPurposePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getLetterContactMechanismPurposePKHasBeenModified() {
        return letterContactMechanismPurposePKHasBeenModified;
    }
    
    public LetterPK getLetterPK() {
        return letterPK;
    }
    
    public void setLetterPK(LetterPK letterPK)
            throws PersistenceNotNullException {
        checkForNull(letterPK);
        
        boolean update = true;
        
        if(this.letterPK != null) {
            if(this.letterPK.equals(letterPK)) {
                update = false;
            }
        } else if(letterPK == null) {
            update = false;
        }
        
        if(update) {
            this.letterPK = letterPK;
            letterPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getLetterPKHasBeenModified() {
        return letterPKHasBeenModified;
    }
    
    public Integer getPriority() {
        return priority;
    }
    
    public void setPriority(Integer priority)
            throws PersistenceNotNullException {
        checkForNull(priority);
        
        boolean update = true;
        
        if(this.priority != null) {
            if(this.priority.equals(priority)) {
                update = false;
            }
        } else if(priority == null) {
            update = false;
        }
        
        if(update) {
            this.priority = priority;
            priorityHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getPriorityHasBeenModified() {
        return priorityHasBeenModified;
    }
    
    public ContactMechanismPurposePK getContactMechanismPurposePK() {
        return contactMechanismPurposePK;
    }
    
    public void setContactMechanismPurposePK(ContactMechanismPurposePK contactMechanismPurposePK)
            throws PersistenceNotNullException {
        checkForNull(contactMechanismPurposePK);
        
        boolean update = true;
        
        if(this.contactMechanismPurposePK != null) {
            if(this.contactMechanismPurposePK.equals(contactMechanismPurposePK)) {
                update = false;
            }
        } else if(contactMechanismPurposePK == null) {
            update = false;
        }
        
        if(update) {
            this.contactMechanismPurposePK = contactMechanismPurposePK;
            contactMechanismPurposePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getContactMechanismPurposePKHasBeenModified() {
        return contactMechanismPurposePKHasBeenModified;
    }
    
    public Long getFromTime() {
        return fromTime;
    }
    
    public void setFromTime(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;
    }
    
    public Long getThruTime() {
        return thruTime;
    }
    
    public void setThruTime(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;
    }
    
}