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

/**
 * PersonValue.java
 */

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

import com.echothree.model.data.party.common.pk.PersonPK;

import com.echothree.model.data.party.server.factory.PersonFactory;

import com.echothree.model.data.party.common.pk.PartyPK;
import com.echothree.model.data.party.common.pk.PersonalTitlePK;
import com.echothree.model.data.party.common.pk.NameSuffixPK;

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 PersonValue
        extends BaseValue<PersonPK>
        implements Cloneable, Serializable {
    
    private PartyPK partyPK;
    private boolean partyPKHasBeenModified = false;
    private PersonalTitlePK personalTitlePK;
    private boolean personalTitlePKHasBeenModified = false;
    private String firstName;
    private boolean firstNameHasBeenModified = false;
    private String firstNameSdx;
    private boolean firstNameSdxHasBeenModified = false;
    private String middleName;
    private boolean middleNameHasBeenModified = false;
    private String middleNameSdx;
    private boolean middleNameSdxHasBeenModified = false;
    private String lastName;
    private boolean lastNameHasBeenModified = false;
    private String lastNameSdx;
    private boolean lastNameSdxHasBeenModified = false;
    private NameSuffixPK nameSuffixPK;
    private boolean nameSuffixPKHasBeenModified = 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(PartyPK partyPK, PersonalTitlePK personalTitlePK, String firstName, String firstNameSdx, String middleName, String middleNameSdx, String lastName, String lastNameSdx, NameSuffixPK nameSuffixPK, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        checkForNull(partyPK);
        this.partyPK = partyPK;
        this.personalTitlePK = personalTitlePK;
        this.firstName = firstName;
        this.firstNameSdx = firstNameSdx;
        this.middleName = middleName;
        this.middleNameSdx = middleNameSdx;
        this.lastName = lastName;
        this.lastNameSdx = lastNameSdx;
        this.nameSuffixPK = nameSuffixPK;
        checkForNull(fromTime);
        this.fromTime = fromTime;
        checkForNull(thruTime);
        this.thruTime = thruTime;
    }
    
    /** Creates a new instance of PersonValue */
    public PersonValue(PersonPK personPK, PartyPK partyPK, PersonalTitlePK personalTitlePK, String firstName, String firstNameSdx, String middleName, String middleNameSdx, String lastName, String lastNameSdx, NameSuffixPK nameSuffixPK, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super(personPK);
        constructFields(partyPK, personalTitlePK, firstName, firstNameSdx, middleName, middleNameSdx, lastName, lastNameSdx, nameSuffixPK, fromTime, thruTime);
    }
    
    /** Creates a new instance of PersonValue */
    public PersonValue(PartyPK partyPK, PersonalTitlePK personalTitlePK, String firstName, String firstNameSdx, String middleName, String middleNameSdx, String lastName, String lastNameSdx, NameSuffixPK nameSuffixPK, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super();
        constructFields(partyPK, personalTitlePK, firstName, firstNameSdx, middleName, middleNameSdx, lastName, lastNameSdx, nameSuffixPK, fromTime, thruTime);
    }
    
    @Override
    @Nonnull
    public PersonFactory getBaseFactoryInstance() {
        return PersonFactory.getInstance();
    }
    
    @Override
    @Nonnull
    public PersonValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (PersonValue)result;
    }
    
    @Override
    @Nonnull
    public PersonPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new PersonPK(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 + ((partyPK != null) ? partyPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((personalTitlePK != null) ? personalTitlePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((firstName != null) ? firstName.hashCode() : 0);
            hashCode = 37 * hashCode + ((firstNameSdx != null) ? firstNameSdx.hashCode() : 0);
            hashCode = 37 * hashCode + ((middleName != null) ? middleName.hashCode() : 0);
            hashCode = 37 * hashCode + ((middleNameSdx != null) ? middleNameSdx.hashCode() : 0);
            hashCode = 37 * hashCode + ((lastName != null) ? lastName.hashCode() : 0);
            hashCode = 37 * hashCode + ((lastNameSdx != null) ? lastNameSdx.hashCode() : 0);
            hashCode = 37 * hashCode + ((nameSuffixPK != null) ? nameSuffixPK.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() +
                    ", partyPK=" + getPartyPK() +
                    ", personalTitlePK=" + getPersonalTitlePK() +
                    ", firstName=" + getFirstName() +
                    ", firstNameSdx=" + getFirstNameSdx() +
                    ", middleName=" + getMiddleName() +
                    ", middleNameSdx=" + getMiddleNameSdx() +
                    ", lastName=" + getLastName() +
                    ", lastNameSdx=" + getLastNameSdx() +
                    ", nameSuffixPK=" + getNameSuffixPK() +
                    ", fromTime=" + getFromTime() +
                    ", thruTime=" + getThruTime() +
                    "}";
        }
        return _stringValue;
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(!hasIdentity())
            return false;
        
        if(other instanceof  PersonValue 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 PersonValue that) {
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                PartyPK thisPartyPK = getPartyPK();
                PartyPK thatPartyPK = that.getPartyPK();
                
                if(thisPartyPK == null) {
                    objectsEqual = objectsEqual && (thatPartyPK == null);
                } else {
                    objectsEqual = objectsEqual && thisPartyPK.equals(thatPartyPK);
                }
            }
            
            if(objectsEqual) {
                PersonalTitlePK thisPersonalTitlePK = getPersonalTitlePK();
                PersonalTitlePK thatPersonalTitlePK = that.getPersonalTitlePK();
                
                if(thisPersonalTitlePK == null) {
                    objectsEqual = objectsEqual && (thatPersonalTitlePK == null);
                } else {
                    objectsEqual = objectsEqual && thisPersonalTitlePK.equals(thatPersonalTitlePK);
                }
            }
            
            if(objectsEqual) {
                String thisFirstName = getFirstName();
                String thatFirstName = that.getFirstName();
                
                if(thisFirstName == null) {
                    objectsEqual = objectsEqual && (thatFirstName == null);
                } else {
                    objectsEqual = objectsEqual && thisFirstName.equals(thatFirstName);
                }
            }
            
            if(objectsEqual) {
                String thisFirstNameSdx = getFirstNameSdx();
                String thatFirstNameSdx = that.getFirstNameSdx();
                
                if(thisFirstNameSdx == null) {
                    objectsEqual = objectsEqual && (thatFirstNameSdx == null);
                } else {
                    objectsEqual = objectsEqual && thisFirstNameSdx.equals(thatFirstNameSdx);
                }
            }
            
            if(objectsEqual) {
                String thisMiddleName = getMiddleName();
                String thatMiddleName = that.getMiddleName();
                
                if(thisMiddleName == null) {
                    objectsEqual = objectsEqual && (thatMiddleName == null);
                } else {
                    objectsEqual = objectsEqual && thisMiddleName.equals(thatMiddleName);
                }
            }
            
            if(objectsEqual) {
                String thisMiddleNameSdx = getMiddleNameSdx();
                String thatMiddleNameSdx = that.getMiddleNameSdx();
                
                if(thisMiddleNameSdx == null) {
                    objectsEqual = objectsEqual && (thatMiddleNameSdx == null);
                } else {
                    objectsEqual = objectsEqual && thisMiddleNameSdx.equals(thatMiddleNameSdx);
                }
            }
            
            if(objectsEqual) {
                String thisLastName = getLastName();
                String thatLastName = that.getLastName();
                
                if(thisLastName == null) {
                    objectsEqual = objectsEqual && (thatLastName == null);
                } else {
                    objectsEqual = objectsEqual && thisLastName.equals(thatLastName);
                }
            }
            
            if(objectsEqual) {
                String thisLastNameSdx = getLastNameSdx();
                String thatLastNameSdx = that.getLastNameSdx();
                
                if(thisLastNameSdx == null) {
                    objectsEqual = objectsEqual && (thatLastNameSdx == null);
                } else {
                    objectsEqual = objectsEqual && thisLastNameSdx.equals(thatLastNameSdx);
                }
            }
            
            if(objectsEqual) {
                NameSuffixPK thisNameSuffixPK = getNameSuffixPK();
                NameSuffixPK thatNameSuffixPK = that.getNameSuffixPK();
                
                if(thisNameSuffixPK == null) {
                    objectsEqual = objectsEqual && (thatNameSuffixPK == null);
                } else {
                    objectsEqual = objectsEqual && thisNameSuffixPK.equals(thatNameSuffixPK);
                }
            }
            
            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 partyPKHasBeenModified || personalTitlePKHasBeenModified || firstNameHasBeenModified || firstNameSdxHasBeenModified || middleNameHasBeenModified || middleNameSdxHasBeenModified || lastNameHasBeenModified || lastNameSdxHasBeenModified || nameSuffixPKHasBeenModified || fromTimeHasBeenModified || thruTimeHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        partyPKHasBeenModified = false;
        personalTitlePKHasBeenModified = false;
        firstNameHasBeenModified = false;
        firstNameSdxHasBeenModified = false;
        middleNameHasBeenModified = false;
        middleNameSdxHasBeenModified = false;
        lastNameHasBeenModified = false;
        lastNameSdxHasBeenModified = false;
        nameSuffixPKHasBeenModified = false;
        fromTimeHasBeenModified = false;
        thruTimeHasBeenModified = false;
    }
    
    @Nonnull
    public PartyPK getPartyPK() {
        return partyPK;
    }
    
    public void setPartyPK(@Nonnull PartyPK partyPK)
            throws PersistenceNotNullException {
        checkForNull(partyPK);
        
        boolean update = true;
        
        if(this.partyPK != null) {
            if(this.partyPK.equals(partyPK)) {
                update = false;
            }
        } else if(partyPK == null) {
            update = false;
        }
        
        if(update) {
            this.partyPK = partyPK;
            partyPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getPartyPKHasBeenModified() {
        return partyPKHasBeenModified;
    }
    
    @Nullable
    public PersonalTitlePK getPersonalTitlePK() {
        return personalTitlePK;
    }
    
    public void setPersonalTitlePK(@Nullable PersonalTitlePK personalTitlePK) {
        boolean update = true;
        
        if(this.personalTitlePK != null) {
            if(this.personalTitlePK.equals(personalTitlePK)) {
                update = false;
            }
        } else if(personalTitlePK == null) {
            update = false;
        }
        
        if(update) {
            this.personalTitlePK = personalTitlePK;
            personalTitlePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getPersonalTitlePKHasBeenModified() {
        return personalTitlePKHasBeenModified;
    }
    
    @Nullable
    public String getFirstName() {
        return firstName;
    }
    
    public void setFirstName(@Nullable String firstName) {
        boolean update = true;
        
        if(this.firstName != null) {
            if(this.firstName.equals(firstName)) {
                update = false;
            }
        } else if(firstName == null) {
            update = false;
        }
        
        if(update) {
            this.firstName = firstName;
            firstNameHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getFirstNameHasBeenModified() {
        return firstNameHasBeenModified;
    }
    
    @Nullable
    public String getFirstNameSdx() {
        return firstNameSdx;
    }
    
    public void setFirstNameSdx(@Nullable String firstNameSdx) {
        boolean update = true;
        
        if(this.firstNameSdx != null) {
            if(this.firstNameSdx.equals(firstNameSdx)) {
                update = false;
            }
        } else if(firstNameSdx == null) {
            update = false;
        }
        
        if(update) {
            this.firstNameSdx = firstNameSdx;
            firstNameSdxHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getFirstNameSdxHasBeenModified() {
        return firstNameSdxHasBeenModified;
    }
    
    @Nullable
    public String getMiddleName() {
        return middleName;
    }
    
    public void setMiddleName(@Nullable String middleName) {
        boolean update = true;
        
        if(this.middleName != null) {
            if(this.middleName.equals(middleName)) {
                update = false;
            }
        } else if(middleName == null) {
            update = false;
        }
        
        if(update) {
            this.middleName = middleName;
            middleNameHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getMiddleNameHasBeenModified() {
        return middleNameHasBeenModified;
    }
    
    @Nullable
    public String getMiddleNameSdx() {
        return middleNameSdx;
    }
    
    public void setMiddleNameSdx(@Nullable String middleNameSdx) {
        boolean update = true;
        
        if(this.middleNameSdx != null) {
            if(this.middleNameSdx.equals(middleNameSdx)) {
                update = false;
            }
        } else if(middleNameSdx == null) {
            update = false;
        }
        
        if(update) {
            this.middleNameSdx = middleNameSdx;
            middleNameSdxHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getMiddleNameSdxHasBeenModified() {
        return middleNameSdxHasBeenModified;
    }
    
    @Nullable
    public String getLastName() {
        return lastName;
    }
    
    public void setLastName(@Nullable String lastName) {
        boolean update = true;
        
        if(this.lastName != null) {
            if(this.lastName.equals(lastName)) {
                update = false;
            }
        } else if(lastName == null) {
            update = false;
        }
        
        if(update) {
            this.lastName = lastName;
            lastNameHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getLastNameHasBeenModified() {
        return lastNameHasBeenModified;
    }
    
    @Nullable
    public String getLastNameSdx() {
        return lastNameSdx;
    }
    
    public void setLastNameSdx(@Nullable String lastNameSdx) {
        boolean update = true;
        
        if(this.lastNameSdx != null) {
            if(this.lastNameSdx.equals(lastNameSdx)) {
                update = false;
            }
        } else if(lastNameSdx == null) {
            update = false;
        }
        
        if(update) {
            this.lastNameSdx = lastNameSdx;
            lastNameSdxHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getLastNameSdxHasBeenModified() {
        return lastNameSdxHasBeenModified;
    }
    
    @Nullable
    public NameSuffixPK getNameSuffixPK() {
        return nameSuffixPK;
    }
    
    public void setNameSuffixPK(@Nullable NameSuffixPK nameSuffixPK) {
        boolean update = true;
        
        if(this.nameSuffixPK != null) {
            if(this.nameSuffixPK.equals(nameSuffixPK)) {
                update = false;
            }
        } else if(nameSuffixPK == null) {
            update = false;
        }
        
        if(update) {
            this.nameSuffixPK = nameSuffixPK;
            nameSuffixPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getNameSuffixPKHasBeenModified() {
        return nameSuffixPKHasBeenModified;
    }
    
    @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;
    }
    
}