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

/**
 * CachedExecutedSearchResultValue.java
 */

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

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

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

import com.echothree.model.data.search.common.pk.CachedExecutedSearchPK;
import com.echothree.model.data.core.common.pk.EntityInstancePK;

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 CachedExecutedSearchResultValue
        extends BaseValue<CachedExecutedSearchResultPK>
        implements Cloneable, Serializable {
    
    private CachedExecutedSearchPK cachedExecutedSearchPK;
    private boolean cachedExecutedSearchPKHasBeenModified = false;
    private EntityInstancePK entityInstancePK;
    private boolean entityInstancePKHasBeenModified = false;
    private Integer sortOrder;
    private boolean sortOrderHasBeenModified = false;
    
    private transient Integer _hashCode = null;
    private transient String _stringValue = null;
    
    private void constructFields(CachedExecutedSearchPK cachedExecutedSearchPK, EntityInstancePK entityInstancePK, Integer sortOrder)
            throws PersistenceNotNullException {
        checkForNull(cachedExecutedSearchPK);
        this.cachedExecutedSearchPK = cachedExecutedSearchPK;
        checkForNull(entityInstancePK);
        this.entityInstancePK = entityInstancePK;
        checkForNull(sortOrder);
        this.sortOrder = sortOrder;
    }
    
    /** Creates a new instance of CachedExecutedSearchResultValue */
    public CachedExecutedSearchResultValue(CachedExecutedSearchResultPK cachedExecutedSearchResultPK, CachedExecutedSearchPK cachedExecutedSearchPK, EntityInstancePK entityInstancePK, Integer sortOrder)
            throws PersistenceNotNullException {
        super(cachedExecutedSearchResultPK);
        constructFields(cachedExecutedSearchPK, entityInstancePK, sortOrder);
    }
    
    /** Creates a new instance of CachedExecutedSearchResultValue */
    public CachedExecutedSearchResultValue(CachedExecutedSearchPK cachedExecutedSearchPK, EntityInstancePK entityInstancePK, Integer sortOrder)
            throws PersistenceNotNullException {
        super();
        constructFields(cachedExecutedSearchPK, entityInstancePK, sortOrder);
    }
    
    @Override
    @Nonnull
    public CachedExecutedSearchResultFactory getBaseFactoryInstance() {
        return CachedExecutedSearchResultFactory.getInstance();
    }
    
    @Override
    @Nonnull
    public CachedExecutedSearchResultValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (CachedExecutedSearchResultValue)result;
    }
    
    @Override
    @Nonnull
    public CachedExecutedSearchResultPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new CachedExecutedSearchResultPK(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 + ((cachedExecutedSearchPK != null) ? cachedExecutedSearchPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((entityInstancePK != null) ? entityInstancePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((sortOrder != null) ? sortOrder.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    @Nonnull
    public String toString() {
        if(_stringValue == null) {
            _stringValue = "{" + 
                    "entityId=" + getEntityId() +
                    ", cachedExecutedSearchPK=" + getCachedExecutedSearchPK() +
                    ", entityInstancePK=" + getEntityInstancePK() +
                    ", sortOrder=" + getSortOrder() +
                    "}";
        }
        return _stringValue;
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(!hasIdentity())
            return false;
        
        if(other instanceof  CachedExecutedSearchResultValue 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 CachedExecutedSearchResultValue that) {
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                CachedExecutedSearchPK thisCachedExecutedSearchPK = getCachedExecutedSearchPK();
                CachedExecutedSearchPK thatCachedExecutedSearchPK = that.getCachedExecutedSearchPK();
                
                if(thisCachedExecutedSearchPK == null) {
                    objectsEqual = objectsEqual && (thatCachedExecutedSearchPK == null);
                } else {
                    objectsEqual = objectsEqual && thisCachedExecutedSearchPK.equals(thatCachedExecutedSearchPK);
                }
            }
            
            if(objectsEqual) {
                EntityInstancePK thisEntityInstancePK = getEntityInstancePK();
                EntityInstancePK thatEntityInstancePK = that.getEntityInstancePK();
                
                if(thisEntityInstancePK == null) {
                    objectsEqual = objectsEqual && (thatEntityInstancePK == null);
                } else {
                    objectsEqual = objectsEqual && thisEntityInstancePK.equals(thatEntityInstancePK);
                }
            }
            
            if(objectsEqual) {
                Integer thisSortOrder = getSortOrder();
                Integer thatSortOrder = that.getSortOrder();
                
                if(thisSortOrder == null) {
                    objectsEqual = objectsEqual && (thatSortOrder == null);
                } else {
                    objectsEqual = objectsEqual && thisSortOrder.equals(thatSortOrder);
                }
            }
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    @Override
    public boolean hasBeenModified() {
        return cachedExecutedSearchPKHasBeenModified || entityInstancePKHasBeenModified || sortOrderHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        cachedExecutedSearchPKHasBeenModified = false;
        entityInstancePKHasBeenModified = false;
        sortOrderHasBeenModified = false;
    }
    
    @Nonnull
    public CachedExecutedSearchPK getCachedExecutedSearchPK() {
        return cachedExecutedSearchPK;
    }
    
    public void setCachedExecutedSearchPK(@Nonnull CachedExecutedSearchPK cachedExecutedSearchPK)
            throws PersistenceNotNullException {
        checkForNull(cachedExecutedSearchPK);
        
        boolean update = true;
        
        if(this.cachedExecutedSearchPK != null) {
            if(this.cachedExecutedSearchPK.equals(cachedExecutedSearchPK)) {
                update = false;
            }
        } else if(cachedExecutedSearchPK == null) {
            update = false;
        }
        
        if(update) {
            this.cachedExecutedSearchPK = cachedExecutedSearchPK;
            cachedExecutedSearchPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getCachedExecutedSearchPKHasBeenModified() {
        return cachedExecutedSearchPKHasBeenModified;
    }
    
    @Nonnull
    public EntityInstancePK getEntityInstancePK() {
        return entityInstancePK;
    }
    
    public void setEntityInstancePK(@Nonnull EntityInstancePK entityInstancePK)
            throws PersistenceNotNullException {
        checkForNull(entityInstancePK);
        
        boolean update = true;
        
        if(this.entityInstancePK != null) {
            if(this.entityInstancePK.equals(entityInstancePK)) {
                update = false;
            }
        } else if(entityInstancePK == null) {
            update = false;
        }
        
        if(update) {
            this.entityInstancePK = entityInstancePK;
            entityInstancePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getEntityInstancePKHasBeenModified() {
        return entityInstancePKHasBeenModified;
    }
    
    @Nonnull
    public Integer getSortOrder() {
        return sortOrder;
    }
    
    public void setSortOrder(@Nonnull Integer sortOrder)
            throws PersistenceNotNullException {
        checkForNull(sortOrder);
        
        boolean update = true;
        
        if(this.sortOrder != null) {
            if(this.sortOrder.equals(sortOrder)) {
                update = false;
            }
        } else if(sortOrder == null) {
            update = false;
        }
        
        if(update) {
            this.sortOrder = sortOrder;
            sortOrderHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getSortOrderHasBeenModified() {
        return sortOrderHasBeenModified;
    }
    
}