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

/**
 * SearchResultValue.java
 */

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

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

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

import com.echothree.model.data.search.common.pk.SearchPK;
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;

public class SearchResultValue
        extends BaseValue<SearchResultPK>
        implements Cloneable, Serializable {
    
    private SearchPK searchPK;
    private boolean searchPKHasBeenModified = 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(SearchPK searchPK, EntityInstancePK entityInstancePK, Integer sortOrder)
            throws PersistenceNotNullException {
        checkForNull(searchPK);
        this.searchPK = searchPK;
        checkForNull(entityInstancePK);
        this.entityInstancePK = entityInstancePK;
        checkForNull(sortOrder);
        this.sortOrder = sortOrder;
    }
    
    /** Creates a new instance of SearchResultValue */
    public SearchResultValue(SearchResultPK searchResultPK, SearchPK searchPK, EntityInstancePK entityInstancePK, Integer sortOrder)
            throws PersistenceNotNullException {
        super(searchResultPK);
        constructFields(searchPK, entityInstancePK, sortOrder);
    }
    
    /** Creates a new instance of SearchResultValue */
    public SearchResultValue(SearchPK searchPK, EntityInstancePK entityInstancePK, Integer sortOrder)
            throws PersistenceNotNullException {
        super();
        constructFields(searchPK, entityInstancePK, sortOrder);
    }
    
   @Override
   public SearchResultFactory getBaseFactoryInstance() {
        return SearchResultFactory.getInstance();
    }
    
    @Override
    public SearchResultValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (SearchResultValue)result;
    }
    
   @Override
    public SearchResultPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new SearchResultPK(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 + ((searchPK != null) ? searchPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((entityInstancePK != null) ? entityInstancePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((sortOrder != null) ? sortOrder.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    public String toString() {
        if(_stringValue == null) {
            StringBuilder stringValue = new StringBuilder("{");
            
            stringValue.append("entityId=").append(getEntityId());
            
            stringValue.append(", searchPK=").append(getSearchPK());
            stringValue.append(", entityInstancePK=").append(getEntityInstancePK());
            stringValue.append(", sortOrder=").append(getSortOrder());
            
            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  SearchResultValue) {
            SearchResultValue that = (SearchResultValue)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 SearchResultValue) {
            SearchResultValue that = (SearchResultValue)other;
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                SearchPK thisSearchPK = getSearchPK();
                SearchPK thatSearchPK = that.getSearchPK();
                
                if(thisSearchPK == null) {
                    objectsEqual = objectsEqual && (thatSearchPK == null);
                } else {
                    objectsEqual = objectsEqual && thisSearchPK.equals(thatSearchPK);
                }
            }
            
            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 searchPKHasBeenModified || entityInstancePKHasBeenModified || sortOrderHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        searchPKHasBeenModified = false;
        entityInstancePKHasBeenModified = false;
        sortOrderHasBeenModified = false;
    }
    
    public SearchPK getSearchPK() {
        return searchPK;
    }
    
    public void setSearchPK(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;
    }
    
    public EntityInstancePK getEntityInstancePK() {
        return entityInstancePK;
    }
    
    public void setEntityInstancePK(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;
    }
    
    public Integer getSortOrder() {
        return sortOrder;
    }
    
    public void setSortOrder(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;
    }
    
}