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

/**
 * UserVisitStatusValue.java
 */

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

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

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

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

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 UserVisitStatusValue
        extends BaseValue<UserVisitStatusPK>
        implements Cloneable, Serializable {
    
    private UserVisitPK userVisitPK;
    private boolean userVisitPKHasBeenModified = false;
    private Integer userVisitCommandSequence;
    private boolean userVisitCommandSequenceHasBeenModified = false;
    private Integer userVisitCachedSearchSequence;
    private boolean userVisitCachedSearchSequenceHasBeenModified = false;
    private Integer userVisitCampaignSequence;
    private boolean userVisitCampaignSequenceHasBeenModified = false;
    private Integer userVisitTrackSequence;
    private boolean userVisitTrackSequenceHasBeenModified = false;
    
    private transient Integer _hashCode = null;
    private transient String _stringValue = null;
    
    private void constructFields(UserVisitPK userVisitPK, Integer userVisitCommandSequence, Integer userVisitCachedSearchSequence, Integer userVisitCampaignSequence, Integer userVisitTrackSequence)
            throws PersistenceNotNullException {
        checkForNull(userVisitPK);
        this.userVisitPK = userVisitPK;
        checkForNull(userVisitCommandSequence);
        this.userVisitCommandSequence = userVisitCommandSequence;
        checkForNull(userVisitCachedSearchSequence);
        this.userVisitCachedSearchSequence = userVisitCachedSearchSequence;
        checkForNull(userVisitCampaignSequence);
        this.userVisitCampaignSequence = userVisitCampaignSequence;
        checkForNull(userVisitTrackSequence);
        this.userVisitTrackSequence = userVisitTrackSequence;
    }
    
    /** Creates a new instance of UserVisitStatusValue */
    public UserVisitStatusValue(UserVisitStatusPK userVisitStatusPK, UserVisitPK userVisitPK, Integer userVisitCommandSequence, Integer userVisitCachedSearchSequence, Integer userVisitCampaignSequence, Integer userVisitTrackSequence)
            throws PersistenceNotNullException {
        super(userVisitStatusPK);
        constructFields(userVisitPK, userVisitCommandSequence, userVisitCachedSearchSequence, userVisitCampaignSequence, userVisitTrackSequence);
    }
    
    /** Creates a new instance of UserVisitStatusValue */
    public UserVisitStatusValue(UserVisitPK userVisitPK, Integer userVisitCommandSequence, Integer userVisitCachedSearchSequence, Integer userVisitCampaignSequence, Integer userVisitTrackSequence)
            throws PersistenceNotNullException {
        super();
        constructFields(userVisitPK, userVisitCommandSequence, userVisitCachedSearchSequence, userVisitCampaignSequence, userVisitTrackSequence);
    }
    
   @Override
   public UserVisitStatusFactory getBaseFactoryInstance() {
        return UserVisitStatusFactory.getInstance();
    }
    
    @Override
    public UserVisitStatusValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (UserVisitStatusValue)result;
    }
    
   @Override
    public UserVisitStatusPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new UserVisitStatusPK(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 + ((userVisitPK != null) ? userVisitPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((userVisitCommandSequence != null) ? userVisitCommandSequence.hashCode() : 0);
            hashCode = 37 * hashCode + ((userVisitCachedSearchSequence != null) ? userVisitCachedSearchSequence.hashCode() : 0);
            hashCode = 37 * hashCode + ((userVisitCampaignSequence != null) ? userVisitCampaignSequence.hashCode() : 0);
            hashCode = 37 * hashCode + ((userVisitTrackSequence != null) ? userVisitTrackSequence.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    public String toString() {
        if(_stringValue == null) {
            StringBuilder stringValue = new StringBuilder("{");
            
            stringValue.append("entityId=").append(getEntityId());
            
            stringValue.append(", userVisitPK=").append(getUserVisitPK());
            stringValue.append(", userVisitCommandSequence=").append(getUserVisitCommandSequence());
            stringValue.append(", userVisitCachedSearchSequence=").append(getUserVisitCachedSearchSequence());
            stringValue.append(", userVisitCampaignSequence=").append(getUserVisitCampaignSequence());
            stringValue.append(", userVisitTrackSequence=").append(getUserVisitTrackSequence());
            
            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  UserVisitStatusValue) {
            UserVisitStatusValue that = (UserVisitStatusValue)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 UserVisitStatusValue) {
            UserVisitStatusValue that = (UserVisitStatusValue)other;
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                UserVisitPK thisUserVisitPK = getUserVisitPK();
                UserVisitPK thatUserVisitPK = that.getUserVisitPK();
                
                if(thisUserVisitPK == null) {
                    objectsEqual = objectsEqual && (thatUserVisitPK == null);
                } else {
                    objectsEqual = objectsEqual && thisUserVisitPK.equals(thatUserVisitPK);
                }
            }
            
            if(objectsEqual) {
                Integer thisUserVisitCommandSequence = getUserVisitCommandSequence();
                Integer thatUserVisitCommandSequence = that.getUserVisitCommandSequence();
                
                if(thisUserVisitCommandSequence == null) {
                    objectsEqual = objectsEqual && (thatUserVisitCommandSequence == null);
                } else {
                    objectsEqual = objectsEqual && thisUserVisitCommandSequence.equals(thatUserVisitCommandSequence);
                }
            }
            
            if(objectsEqual) {
                Integer thisUserVisitCachedSearchSequence = getUserVisitCachedSearchSequence();
                Integer thatUserVisitCachedSearchSequence = that.getUserVisitCachedSearchSequence();
                
                if(thisUserVisitCachedSearchSequence == null) {
                    objectsEqual = objectsEqual && (thatUserVisitCachedSearchSequence == null);
                } else {
                    objectsEqual = objectsEqual && thisUserVisitCachedSearchSequence.equals(thatUserVisitCachedSearchSequence);
                }
            }
            
            if(objectsEqual) {
                Integer thisUserVisitCampaignSequence = getUserVisitCampaignSequence();
                Integer thatUserVisitCampaignSequence = that.getUserVisitCampaignSequence();
                
                if(thisUserVisitCampaignSequence == null) {
                    objectsEqual = objectsEqual && (thatUserVisitCampaignSequence == null);
                } else {
                    objectsEqual = objectsEqual && thisUserVisitCampaignSequence.equals(thatUserVisitCampaignSequence);
                }
            }
            
            if(objectsEqual) {
                Integer thisUserVisitTrackSequence = getUserVisitTrackSequence();
                Integer thatUserVisitTrackSequence = that.getUserVisitTrackSequence();
                
                if(thisUserVisitTrackSequence == null) {
                    objectsEqual = objectsEqual && (thatUserVisitTrackSequence == null);
                } else {
                    objectsEqual = objectsEqual && thisUserVisitTrackSequence.equals(thatUserVisitTrackSequence);
                }
            }
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    @Override
    public boolean hasBeenModified() {
        return userVisitPKHasBeenModified || userVisitCommandSequenceHasBeenModified || userVisitCachedSearchSequenceHasBeenModified || userVisitCampaignSequenceHasBeenModified || userVisitTrackSequenceHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        userVisitPKHasBeenModified = false;
        userVisitCommandSequenceHasBeenModified = false;
        userVisitCachedSearchSequenceHasBeenModified = false;
        userVisitCampaignSequenceHasBeenModified = false;
        userVisitTrackSequenceHasBeenModified = false;
    }
    
    public UserVisitPK getUserVisitPK() {
        return userVisitPK;
    }
    
    public void setUserVisitPK(UserVisitPK userVisitPK)
            throws PersistenceNotNullException {
        checkForNull(userVisitPK);
        
        boolean update = true;
        
        if(this.userVisitPK != null) {
            if(this.userVisitPK.equals(userVisitPK)) {
                update = false;
            }
        } else if(userVisitPK == null) {
            update = false;
        }
        
        if(update) {
            this.userVisitPK = userVisitPK;
            userVisitPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getUserVisitPKHasBeenModified() {
        return userVisitPKHasBeenModified;
    }
    
    public Integer getUserVisitCommandSequence() {
        return userVisitCommandSequence;
    }
    
    public void setUserVisitCommandSequence(Integer userVisitCommandSequence)
            throws PersistenceNotNullException {
        checkForNull(userVisitCommandSequence);
        
        boolean update = true;
        
        if(this.userVisitCommandSequence != null) {
            if(this.userVisitCommandSequence.equals(userVisitCommandSequence)) {
                update = false;
            }
        } else if(userVisitCommandSequence == null) {
            update = false;
        }
        
        if(update) {
            this.userVisitCommandSequence = userVisitCommandSequence;
            userVisitCommandSequenceHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getUserVisitCommandSequenceHasBeenModified() {
        return userVisitCommandSequenceHasBeenModified;
    }
    
    public Integer getUserVisitCachedSearchSequence() {
        return userVisitCachedSearchSequence;
    }
    
    public void setUserVisitCachedSearchSequence(Integer userVisitCachedSearchSequence)
            throws PersistenceNotNullException {
        checkForNull(userVisitCachedSearchSequence);
        
        boolean update = true;
        
        if(this.userVisitCachedSearchSequence != null) {
            if(this.userVisitCachedSearchSequence.equals(userVisitCachedSearchSequence)) {
                update = false;
            }
        } else if(userVisitCachedSearchSequence == null) {
            update = false;
        }
        
        if(update) {
            this.userVisitCachedSearchSequence = userVisitCachedSearchSequence;
            userVisitCachedSearchSequenceHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getUserVisitCachedSearchSequenceHasBeenModified() {
        return userVisitCachedSearchSequenceHasBeenModified;
    }
    
    public Integer getUserVisitCampaignSequence() {
        return userVisitCampaignSequence;
    }
    
    public void setUserVisitCampaignSequence(Integer userVisitCampaignSequence)
            throws PersistenceNotNullException {
        checkForNull(userVisitCampaignSequence);
        
        boolean update = true;
        
        if(this.userVisitCampaignSequence != null) {
            if(this.userVisitCampaignSequence.equals(userVisitCampaignSequence)) {
                update = false;
            }
        } else if(userVisitCampaignSequence == null) {
            update = false;
        }
        
        if(update) {
            this.userVisitCampaignSequence = userVisitCampaignSequence;
            userVisitCampaignSequenceHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getUserVisitCampaignSequenceHasBeenModified() {
        return userVisitCampaignSequenceHasBeenModified;
    }
    
    public Integer getUserVisitTrackSequence() {
        return userVisitTrackSequence;
    }
    
    public void setUserVisitTrackSequence(Integer userVisitTrackSequence)
            throws PersistenceNotNullException {
        checkForNull(userVisitTrackSequence);
        
        boolean update = true;
        
        if(this.userVisitTrackSequence != null) {
            if(this.userVisitTrackSequence.equals(userVisitTrackSequence)) {
                update = false;
            }
        } else if(userVisitTrackSequence == null) {
            update = false;
        }
        
        if(update) {
            this.userVisitTrackSequence = userVisitTrackSequence;
            userVisitTrackSequenceHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getUserVisitTrackSequenceHasBeenModified() {
        return userVisitTrackSequenceHasBeenModified;
    }
    
}