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

/**
 * UserVisitSearchValue.java
 */

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

import com.echothree.model.data.search.common.pk.UserVisitSearchPK;

import com.echothree.model.data.search.server.factory.UserVisitSearchFactory;

import com.echothree.model.data.user.common.pk.UserVisitPK;
import com.echothree.model.data.search.common.pk.SearchTypePK;
import com.echothree.model.data.search.common.pk.SearchPK;

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 UserVisitSearchValue
        extends BaseValue<UserVisitSearchPK>
        implements Cloneable, Serializable {
    
    private UserVisitPK userVisitPK;
    private boolean userVisitPKHasBeenModified = false;
    private SearchTypePK searchTypePK;
    private boolean searchTypePKHasBeenModified = false;
    private SearchPK searchPK;
    private boolean searchPKHasBeenModified = false;
    
    private transient Integer _hashCode = null;
    private transient String _stringValue = null;
    
    private void constructFields(UserVisitPK userVisitPK, SearchTypePK searchTypePK, SearchPK searchPK)
            throws PersistenceNotNullException {
        checkForNull(userVisitPK);
        this.userVisitPK = userVisitPK;
        checkForNull(searchTypePK);
        this.searchTypePK = searchTypePK;
        checkForNull(searchPK);
        this.searchPK = searchPK;
    }
    
    /** Creates a new instance of UserVisitSearchValue */
    public UserVisitSearchValue(UserVisitSearchPK userVisitSearchPK, UserVisitPK userVisitPK, SearchTypePK searchTypePK, SearchPK searchPK)
            throws PersistenceNotNullException {
        super(userVisitSearchPK);
        constructFields(userVisitPK, searchTypePK, searchPK);
    }
    
    /** Creates a new instance of UserVisitSearchValue */
    public UserVisitSearchValue(UserVisitPK userVisitPK, SearchTypePK searchTypePK, SearchPK searchPK)
            throws PersistenceNotNullException {
        super();
        constructFields(userVisitPK, searchTypePK, searchPK);
    }
    
    @Override
    @Nonnull
    public UserVisitSearchFactory getBaseFactoryInstance() {
        return UserVisitSearchFactory.getInstance();
    }
    
    @Override
    @Nonnull
    public UserVisitSearchValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (UserVisitSearchValue)result;
    }
    
    @Override
    @Nonnull
    public UserVisitSearchPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new UserVisitSearchPK(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 + ((searchTypePK != null) ? searchTypePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((searchPK != null) ? searchPK.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    @Nonnull
    public String toString() {
        if(_stringValue == null) {
            _stringValue = "{" + 
                    "entityId=" + getEntityId() +
                    ", userVisitPK=" + getUserVisitPK() +
                    ", searchTypePK=" + getSearchTypePK() +
                    ", searchPK=" + getSearchPK() +
                    "}";
        }
        return _stringValue;
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(!hasIdentity())
            return false;
        
        if(other instanceof  UserVisitSearchValue 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 UserVisitSearchValue that) {
            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) {
                SearchTypePK thisSearchTypePK = getSearchTypePK();
                SearchTypePK thatSearchTypePK = that.getSearchTypePK();
                
                if(thisSearchTypePK == null) {
                    objectsEqual = objectsEqual && (thatSearchTypePK == null);
                } else {
                    objectsEqual = objectsEqual && thisSearchTypePK.equals(thatSearchTypePK);
                }
            }
            
            if(objectsEqual) {
                SearchPK thisSearchPK = getSearchPK();
                SearchPK thatSearchPK = that.getSearchPK();
                
                if(thisSearchPK == null) {
                    objectsEqual = objectsEqual && (thatSearchPK == null);
                } else {
                    objectsEqual = objectsEqual && thisSearchPK.equals(thatSearchPK);
                }
            }
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    @Override
    public boolean hasBeenModified() {
        return userVisitPKHasBeenModified || searchTypePKHasBeenModified || searchPKHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        userVisitPKHasBeenModified = false;
        searchTypePKHasBeenModified = false;
        searchPKHasBeenModified = false;
    }
    
    @Nonnull
    public UserVisitPK getUserVisitPK() {
        return userVisitPK;
    }
    
    public void setUserVisitPK(@Nonnull 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;
    }
    
    @Nonnull
    public SearchTypePK getSearchTypePK() {
        return searchTypePK;
    }
    
    public void setSearchTypePK(@Nonnull SearchTypePK searchTypePK)
            throws PersistenceNotNullException {
        checkForNull(searchTypePK);
        
        boolean update = true;
        
        if(this.searchTypePK != null) {
            if(this.searchTypePK.equals(searchTypePK)) {
                update = false;
            }
        } else if(searchTypePK == null) {
            update = false;
        }
        
        if(update) {
            this.searchTypePK = searchTypePK;
            searchTypePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getSearchTypePKHasBeenModified() {
        return searchTypePKHasBeenModified;
    }
    
    @Nonnull
    public SearchPK getSearchPK() {
        return searchPK;
    }
    
    public void setSearchPK(@Nonnull SearchPK searchPK)
            throws PersistenceNotNullException {
        checkForNull(searchPK);
        
        boolean update = true;
        
        if(this.searchPK != null) {
            if(this.searchPK.equals(searchPK)) {
                update = false;
            }
        } else if(searchPK == null) {
            update = false;
        }
        
        if(update) {
            this.searchPK = searchPK;
            searchPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getSearchPKHasBeenModified() {
        return searchPKHasBeenModified;
    }
    
}