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

/**
 * UserKeyDetailValue.java
 */

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

import com.echothree.model.data.user.common.pk.UserKeyDetailPK;

import com.echothree.model.data.user.server.factory.UserKeyDetailFactory;

import com.echothree.model.data.user.common.pk.UserKeyPK;
import com.echothree.model.data.party.common.pk.PartyPK;
import com.echothree.model.data.party.common.pk.PartyRelationshipPK;

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 UserKeyDetailValue
        extends BaseValue<UserKeyDetailPK>
        implements Cloneable, Serializable {
    
    private UserKeyPK userKeyPK;
    private boolean userKeyPKHasBeenModified = false;
    private String userKeyName;
    private boolean userKeyNameHasBeenModified = false;
    private PartyPK partyPK;
    private boolean partyPKHasBeenModified = false;
    private PartyRelationshipPK partyRelationshipPK;
    private boolean partyRelationshipPKHasBeenModified = 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(UserKeyPK userKeyPK, String userKeyName, PartyPK partyPK, PartyRelationshipPK partyRelationshipPK, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        checkForNull(userKeyPK);
        this.userKeyPK = userKeyPK;
        checkForNull(userKeyName);
        this.userKeyName = userKeyName;
        this.partyPK = partyPK;
        this.partyRelationshipPK = partyRelationshipPK;
        checkForNull(fromTime);
        this.fromTime = fromTime;
        checkForNull(thruTime);
        this.thruTime = thruTime;
    }
    
    /** Creates a new instance of UserKeyDetailValue */
    public UserKeyDetailValue(UserKeyDetailPK userKeyDetailPK, UserKeyPK userKeyPK, String userKeyName, PartyPK partyPK, PartyRelationshipPK partyRelationshipPK, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super(userKeyDetailPK);
        constructFields(userKeyPK, userKeyName, partyPK, partyRelationshipPK, fromTime, thruTime);
    }
    
    /** Creates a new instance of UserKeyDetailValue */
    public UserKeyDetailValue(UserKeyPK userKeyPK, String userKeyName, PartyPK partyPK, PartyRelationshipPK partyRelationshipPK, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super();
        constructFields(userKeyPK, userKeyName, partyPK, partyRelationshipPK, fromTime, thruTime);
    }
    
   @Override
   public UserKeyDetailFactory getBaseFactoryInstance() {
        return UserKeyDetailFactory.getInstance();
    }
    
    @Override
    public UserKeyDetailValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (UserKeyDetailValue)result;
    }
    
   @Override
    public UserKeyDetailPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new UserKeyDetailPK(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 + ((userKeyPK != null) ? userKeyPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((userKeyName != null) ? userKeyName.hashCode() : 0);
            hashCode = 37 * hashCode + ((partyPK != null) ? partyPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((partyRelationshipPK != null) ? partyRelationshipPK.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(", userKeyPK=").append(getUserKeyPK());
            stringValue.append(", userKeyName=").append(getUserKeyName());
            stringValue.append(", partyPK=").append(getPartyPK());
            stringValue.append(", partyRelationshipPK=").append(getPartyRelationshipPK());
            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  UserKeyDetailValue) {
            UserKeyDetailValue that = (UserKeyDetailValue)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 UserKeyDetailValue) {
            UserKeyDetailValue that = (UserKeyDetailValue)other;
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                UserKeyPK thisUserKeyPK = getUserKeyPK();
                UserKeyPK thatUserKeyPK = that.getUserKeyPK();
                
                if(thisUserKeyPK == null) {
                    objectsEqual = objectsEqual && (thatUserKeyPK == null);
                } else {
                    objectsEqual = objectsEqual && thisUserKeyPK.equals(thatUserKeyPK);
                }
            }
            
            if(objectsEqual) {
                String thisUserKeyName = getUserKeyName();
                String thatUserKeyName = that.getUserKeyName();
                
                if(thisUserKeyName == null) {
                    objectsEqual = objectsEqual && (thatUserKeyName == null);
                } else {
                    objectsEqual = objectsEqual && thisUserKeyName.equals(thatUserKeyName);
                }
            }
            
            if(objectsEqual) {
                PartyPK thisPartyPK = getPartyPK();
                PartyPK thatPartyPK = that.getPartyPK();
                
                if(thisPartyPK == null) {
                    objectsEqual = objectsEqual && (thatPartyPK == null);
                } else {
                    objectsEqual = objectsEqual && thisPartyPK.equals(thatPartyPK);
                }
            }
            
            if(objectsEqual) {
                PartyRelationshipPK thisPartyRelationshipPK = getPartyRelationshipPK();
                PartyRelationshipPK thatPartyRelationshipPK = that.getPartyRelationshipPK();
                
                if(thisPartyRelationshipPK == null) {
                    objectsEqual = objectsEqual && (thatPartyRelationshipPK == null);
                } else {
                    objectsEqual = objectsEqual && thisPartyRelationshipPK.equals(thatPartyRelationshipPK);
                }
            }
            
            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 userKeyPKHasBeenModified || userKeyNameHasBeenModified || partyPKHasBeenModified || partyRelationshipPKHasBeenModified || fromTimeHasBeenModified || thruTimeHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        userKeyPKHasBeenModified = false;
        userKeyNameHasBeenModified = false;
        partyPKHasBeenModified = false;
        partyRelationshipPKHasBeenModified = false;
        fromTimeHasBeenModified = false;
        thruTimeHasBeenModified = false;
    }
    
    public UserKeyPK getUserKeyPK() {
        return userKeyPK;
    }
    
    public void setUserKeyPK(UserKeyPK userKeyPK)
            throws PersistenceNotNullException {
        checkForNull(userKeyPK);
        
        boolean update = true;
        
        if(this.userKeyPK != null) {
            if(this.userKeyPK.equals(userKeyPK)) {
                update = false;
            }
        } else if(userKeyPK == null) {
            update = false;
        }
        
        if(update) {
            this.userKeyPK = userKeyPK;
            userKeyPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getUserKeyPKHasBeenModified() {
        return userKeyPKHasBeenModified;
    }
    
    public String getUserKeyName() {
        return userKeyName;
    }
    
    public void setUserKeyName(String userKeyName)
            throws PersistenceNotNullException {
        checkForNull(userKeyName);
        
        boolean update = true;
        
        if(this.userKeyName != null) {
            if(this.userKeyName.equals(userKeyName)) {
                update = false;
            }
        } else if(userKeyName == null) {
            update = false;
        }
        
        if(update) {
            this.userKeyName = userKeyName;
            userKeyNameHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getUserKeyNameHasBeenModified() {
        return userKeyNameHasBeenModified;
    }
    
    public PartyPK getPartyPK() {
        return partyPK;
    }
    
    public void setPartyPK(PartyPK 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;
    }
    
    public PartyRelationshipPK getPartyRelationshipPK() {
        return partyRelationshipPK;
    }
    
    public void setPartyRelationshipPK(PartyRelationshipPK partyRelationshipPK) {
        boolean update = true;
        
        if(this.partyRelationshipPK != null) {
            if(this.partyRelationshipPK.equals(partyRelationshipPK)) {
                update = false;
            }
        } else if(partyRelationshipPK == null) {
            update = false;
        }
        
        if(update) {
            this.partyRelationshipPK = partyRelationshipPK;
            partyRelationshipPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getPartyRelationshipPKHasBeenModified() {
        return partyRelationshipPKHasBeenModified;
    }
    
    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;
    }
    
}