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

/**
 * IndexDetail.java
 */

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

import com.echothree.model.data.index.common.pk.IndexDetailPK;

import com.echothree.model.data.index.common.pk.IndexPK;
import com.echothree.model.data.index.common.pk.IndexTypePK;
import com.echothree.model.data.party.common.pk.LanguagePK;

import com.echothree.model.data.index.server.entity.Index;
import com.echothree.model.data.index.server.entity.IndexType;
import com.echothree.model.data.party.server.entity.Language;

import com.echothree.model.data.index.server.factory.IndexFactory;
import com.echothree.model.data.index.server.factory.IndexTypeFactory;
import com.echothree.model.data.party.server.factory.LanguageFactory;

import com.echothree.model.data.index.common.pk.IndexDetailPK;

import com.echothree.model.data.index.server.value.IndexDetailValue;

import com.echothree.model.data.index.server.factory.IndexDetailFactory;

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 IndexDetail
        extends BaseEntity
        implements Serializable {
    
    private IndexDetailPK _pk;
    private IndexDetailValue _value;
    
    /** Creates a new instance of IndexDetail */
    public IndexDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of IndexDetail */
    public IndexDetail(IndexDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public IndexDetailFactory getBaseFactoryInstance() {
        return IndexDetailFactory.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 IndexDetail that) {
            IndexDetailValue thatValue = that.getIndexDetailValue();
            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 IndexDetailValue getIndexDetailValue() {
        return _value;
    }
    
    public void setIndexDetailValue(@Nonnull IndexDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public IndexDetailPK 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 getIndexName() {
        return _value.getIndexName();
    }
    
    public void setIndexName(@Nonnull String indexName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setIndexName(indexName);
    }
    
    public boolean getIndexNameHasBeenModified() {
        return _value.getIndexNameHasBeenModified();
    }
    
    @Nonnull
    public IndexTypePK getIndexTypePK() {
        return _value.getIndexTypePK();
    }
    
    @Nonnull
    public IndexType getIndexType(EntityPermission entityPermission) {
        return IndexTypeFactory.getInstance().getEntityFromPK(entityPermission, getIndexTypePK());
    }
    
    @Nonnull
    public IndexType getIndexType() {
        return getIndexType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public IndexType getIndexTypeForUpdate() {
        return getIndexType(EntityPermission.READ_WRITE);
    }
    
    public void setIndexTypePK(@Nonnull IndexTypePK indexTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setIndexTypePK(indexTypePK);
    }
    
    public void setIndexType(@Nonnull IndexType entity) {
        setIndexTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getIndexTypePKHasBeenModified() {
        return _value.getIndexTypePKHasBeenModified();
    }
    
    @Nullable
    public LanguagePK getLanguagePK() {
        return _value.getLanguagePK();
    }
    
    @Nullable
    public Language getLanguage(EntityPermission entityPermission) {
        LanguagePK pk = getLanguagePK();
        Language entity = pk == null? null: LanguageFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Language getLanguage() {
        return getLanguage(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Language getLanguageForUpdate() {
        return getLanguage(EntityPermission.READ_WRITE);
    }
    
    public void setLanguagePK(@Nullable LanguagePK languagePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setLanguagePK(languagePK);
    }
    
    public void setLanguage(@Nullable Language entity) {
        setLanguagePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getLanguagePKHasBeenModified() {
        return _value.getLanguagePKHasBeenModified();
    }
    
    @Nonnull
    public String getDirectory() {
        return _value.getDirectory();
    }
    
    public void setDirectory(@Nonnull String directory)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setDirectory(directory);
    }
    
    public boolean getDirectoryHasBeenModified() {
        return _value.getDirectoryHasBeenModified();
    }
    
    @Nonnull
    public Boolean getIsDefault() {
        return _value.getIsDefault();
    }
    
    public void setIsDefault(@Nonnull Boolean isDefault)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setIsDefault(isDefault);
    }
    
    public boolean getIsDefaultHasBeenModified() {
        return _value.getIsDefaultHasBeenModified();
    }
    
    @Nonnull
    public Integer getSortOrder() {
        return _value.getSortOrder();
    }
    
    public void setSortOrder(@Nonnull Integer sortOrder)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSortOrder(sortOrder);
    }
    
    public boolean getSortOrderHasBeenModified() {
        return _value.getSortOrderHasBeenModified();
    }
    
    @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();
    }
    
}