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

/**
 * CachedSearch.java
 */

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

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

import com.echothree.model.data.index.common.pk.IndexPK;
import com.echothree.model.data.search.common.pk.SearchDefaultOperatorPK;
import com.echothree.model.data.search.common.pk.SearchSortOrderPK;
import com.echothree.model.data.search.common.pk.SearchSortDirectionPK;

import com.echothree.model.data.index.server.entity.Index;
import com.echothree.model.data.search.server.entity.SearchDefaultOperator;
import com.echothree.model.data.search.server.entity.SearchSortOrder;
import com.echothree.model.data.search.server.entity.SearchSortDirection;

import com.echothree.model.data.index.server.factory.IndexFactory;
import com.echothree.model.data.search.server.factory.SearchDefaultOperatorFactory;
import com.echothree.model.data.search.server.factory.SearchSortOrderFactory;
import com.echothree.model.data.search.server.factory.SearchSortDirectionFactory;

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

import com.echothree.model.data.search.server.value.CachedSearchValue;

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

import com.echothree.util.common.exception.PersistenceException;
import com.echothree.util.common.exception.PersistenceDatabaseException;
import com.echothree.util.common.exception.PersistenceNotNullException;
import com.echothree.util.common.exception.PersistenceReadOnlyException;

import com.echothree.util.common.persistence.BasePK;

import com.echothree.util.common.persistence.type.ByteArray;

import com.echothree.util.server.persistence.BaseEntity;
import com.echothree.util.server.persistence.EntityPermission;
import com.echothree.util.server.persistence.Session;
import com.echothree.util.server.persistence.ThreadSession;

import java.io.Serializable;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

public class CachedSearch
        extends BaseEntity
        implements Serializable {
    
    private CachedSearchPK _pk;
    private CachedSearchValue _value;
    
    /** Creates a new instance of CachedSearch */
    public CachedSearch()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of CachedSearch */
    public CachedSearch(CachedSearchValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public CachedSearchFactory getBaseFactoryInstance() {
        return CachedSearchFactory.getInstance();
    }
    
    @Override
    public boolean hasBeenModified() {
        return _value.hasBeenModified();
    }
    
    @Override
    public int hashCode() {
        return _pk.hashCode();
    }
    
    @Override
    @Nonnull
    public String toString() {
        return _pk.toString();
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(other instanceof CachedSearch that) {
            CachedSearchValue thatValue = that.getCachedSearchValue();
            return _value.equals(thatValue);
        } else {
            return false;
        }
    }
    
    @Override
    public void store()
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().store(this);
    }
    
    @Override
    public void remove()
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().remove(this);
    }
    
    @Nonnull
    public CachedSearchValue getCachedSearchValue() {
        return _value;
    }
    
    public void setCachedSearchValue(@Nonnull CachedSearchValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public CachedSearchPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public IndexPK getIndexPK() {
        return _value.getIndexPK();
    }
    
    @Nonnull
    public Index getIndex(EntityPermission entityPermission) {
        return IndexFactory.getInstance().getEntityFromPK(entityPermission, getIndexPK());
    }
    
    @Nonnull
    public Index getIndex() {
        return getIndex(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Index getIndexForUpdate() {
        return getIndex(EntityPermission.READ_WRITE);
    }
    
    public void setIndexPK(@Nonnull IndexPK indexPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setIndexPK(indexPK);
    }
    
    public void setIndex(@Nonnull Index entity) {
        setIndexPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getIndexPKHasBeenModified() {
        return _value.getIndexPKHasBeenModified();
    }
    
    @Nonnull
    public String getQuerySha1Hash() {
        return _value.getQuerySha1Hash();
    }
    
    public void setQuerySha1Hash(@Nonnull String querySha1Hash)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setQuerySha1Hash(querySha1Hash);
    }
    
    public boolean getQuerySha1HashHasBeenModified() {
        return _value.getQuerySha1HashHasBeenModified();
    }
    
    @Nonnull
    public String getQuery() {
        return _value.getQuery();
    }
    
    public void setQuery(@Nonnull String query)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setQuery(query);
    }
    
    public boolean getQueryHasBeenModified() {
        return _value.getQueryHasBeenModified();
    }
    
    @Nonnull
    public String getParsedQuerySha1Hash() {
        return _value.getParsedQuerySha1Hash();
    }
    
    public void setParsedQuerySha1Hash(@Nonnull String parsedQuerySha1Hash)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setParsedQuerySha1Hash(parsedQuerySha1Hash);
    }
    
    public boolean getParsedQuerySha1HashHasBeenModified() {
        return _value.getParsedQuerySha1HashHasBeenModified();
    }
    
    @Nonnull
    public String getParsedQuery() {
        return _value.getParsedQuery();
    }
    
    public void setParsedQuery(@Nonnull String parsedQuery)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setParsedQuery(parsedQuery);
    }
    
    public boolean getParsedQueryHasBeenModified() {
        return _value.getParsedQueryHasBeenModified();
    }
    
    @Nonnull
    public SearchDefaultOperatorPK getSearchDefaultOperatorPK() {
        return _value.getSearchDefaultOperatorPK();
    }
    
    @Nonnull
    public SearchDefaultOperator getSearchDefaultOperator(EntityPermission entityPermission) {
        return SearchDefaultOperatorFactory.getInstance().getEntityFromPK(entityPermission, getSearchDefaultOperatorPK());
    }
    
    @Nonnull
    public SearchDefaultOperator getSearchDefaultOperator() {
        return getSearchDefaultOperator(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public SearchDefaultOperator getSearchDefaultOperatorForUpdate() {
        return getSearchDefaultOperator(EntityPermission.READ_WRITE);
    }
    
    public void setSearchDefaultOperatorPK(@Nonnull SearchDefaultOperatorPK searchDefaultOperatorPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSearchDefaultOperatorPK(searchDefaultOperatorPK);
    }
    
    public void setSearchDefaultOperator(@Nonnull SearchDefaultOperator entity) {
        setSearchDefaultOperatorPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getSearchDefaultOperatorPKHasBeenModified() {
        return _value.getSearchDefaultOperatorPKHasBeenModified();
    }
    
    @Nonnull
    public SearchSortOrderPK getSearchSortOrderPK() {
        return _value.getSearchSortOrderPK();
    }
    
    @Nonnull
    public SearchSortOrder getSearchSortOrder(EntityPermission entityPermission) {
        return SearchSortOrderFactory.getInstance().getEntityFromPK(entityPermission, getSearchSortOrderPK());
    }
    
    @Nonnull
    public SearchSortOrder getSearchSortOrder() {
        return getSearchSortOrder(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public SearchSortOrder getSearchSortOrderForUpdate() {
        return getSearchSortOrder(EntityPermission.READ_WRITE);
    }
    
    public void setSearchSortOrderPK(@Nonnull SearchSortOrderPK searchSortOrderPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSearchSortOrderPK(searchSortOrderPK);
    }
    
    public void setSearchSortOrder(@Nonnull SearchSortOrder entity) {
        setSearchSortOrderPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getSearchSortOrderPKHasBeenModified() {
        return _value.getSearchSortOrderPKHasBeenModified();
    }
    
    @Nonnull
    public SearchSortDirectionPK getSearchSortDirectionPK() {
        return _value.getSearchSortDirectionPK();
    }
    
    @Nonnull
    public SearchSortDirection getSearchSortDirection(EntityPermission entityPermission) {
        return SearchSortDirectionFactory.getInstance().getEntityFromPK(entityPermission, getSearchSortDirectionPK());
    }
    
    @Nonnull
    public SearchSortDirection getSearchSortDirection() {
        return getSearchSortDirection(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public SearchSortDirection getSearchSortDirectionForUpdate() {
        return getSearchSortDirection(EntityPermission.READ_WRITE);
    }
    
    public void setSearchSortDirectionPK(@Nonnull SearchSortDirectionPK searchSortDirectionPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSearchSortDirectionPK(searchSortDirectionPK);
    }
    
    public void setSearchSortDirection(@Nonnull SearchSortDirection entity) {
        setSearchSortDirectionPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getSearchSortDirectionPKHasBeenModified() {
        return _value.getSearchSortDirectionPKHasBeenModified();
    }
    
    @Nonnull
    public Long getFromTime() {
        return _value.getFromTime();
    }
    
    public void setFromTime(@Nonnull Long fromTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setFromTime(fromTime);
    }
    
    public boolean getFromTimeHasBeenModified() {
        return _value.getFromTimeHasBeenModified();
    }
    
    @Nonnull
    public Long getThruTime() {
        return _value.getThruTime();
    }
    
    public void setThruTime(@Nonnull Long thruTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setThruTime(thruTime);
    }
    
    public boolean getThruTimeHasBeenModified() {
        return _value.getThruTimeHasBeenModified();
    }
    
}