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

/**
 * TermDetail.java
 */

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

import com.echothree.model.data.term.common.pk.TermDetailPK;

import com.echothree.model.data.term.common.pk.TermPK;
import com.echothree.model.data.term.common.pk.TermTypePK;

import com.echothree.model.data.term.server.entity.Term;
import com.echothree.model.data.term.server.entity.TermType;

import com.echothree.model.data.term.server.factory.TermFactory;
import com.echothree.model.data.term.server.factory.TermTypeFactory;

import com.echothree.model.data.term.common.pk.TermDetailPK;

import com.echothree.model.data.term.server.value.TermDetailValue;

import com.echothree.model.data.term.server.factory.TermDetailFactory;

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;

public class TermDetail
        extends BaseEntity
        implements Serializable {
    
    private TermDetailPK _pk;
    private TermDetailValue _value;
    
    /** Creates a new instance of TermDetail */
    public TermDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of TermDetail */
    public TermDetail(TermDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    public TermDetailFactory getBaseFactoryInstance() {
        return TermDetailFactory.getInstance();
    }
    
    @Override
    public boolean hasBeenModified() {
        return _value.hasBeenModified();
    }
    
    @Override
    public int hashCode() {
        return _pk.hashCode();
    }
    
    @Override
    public String toString() {
        return _pk.toString();
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(other instanceof TermDetail that) {
            TermDetailValue thatValue = that.getTermDetailValue();
            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);
    }
    
    public TermDetailValue getTermDetailValue() {
        return _value;
    }
    
    public void setTermDetailValue(TermDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    public TermDetailPK getPrimaryKey() {
        return _pk;
    }
    
    public TermPK getTermPK() {
        return _value.getTermPK();
    }
    
    public Term getTerm(EntityPermission entityPermission) {
        return TermFactory.getInstance().getEntityFromPK(entityPermission, getTermPK());
    }
    
    public Term getTerm() {
        return getTerm(EntityPermission.READ_ONLY);
    }
    
    public Term getTermForUpdate() {
        return getTerm(EntityPermission.READ_WRITE);
    }
    
    public void setTermPK(TermPK termPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setTermPK(termPK);
    }
    
    public void setTerm(Term entity) {
        setTermPK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getTermPKHasBeenModified() {
        return _value.getTermPKHasBeenModified();
    }
    
    public String getTermName() {
        return _value.getTermName();
    }
    
    public void setTermName(String termName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setTermName(termName);
    }
    
    public boolean getTermNameHasBeenModified() {
        return _value.getTermNameHasBeenModified();
    }
    
    public TermTypePK getTermTypePK() {
        return _value.getTermTypePK();
    }
    
    public TermType getTermType(EntityPermission entityPermission) {
        return TermTypeFactory.getInstance().getEntityFromPK(entityPermission, getTermTypePK());
    }
    
    public TermType getTermType() {
        return getTermType(EntityPermission.READ_ONLY);
    }
    
    public TermType getTermTypeForUpdate() {
        return getTermType(EntityPermission.READ_WRITE);
    }
    
    public void setTermTypePK(TermTypePK termTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setTermTypePK(termTypePK);
    }
    
    public void setTermType(TermType entity) {
        setTermTypePK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getTermTypePKHasBeenModified() {
        return _value.getTermTypePKHasBeenModified();
    }
    
    public Boolean getIsDefault() {
        return _value.getIsDefault();
    }
    
    public void setIsDefault(Boolean isDefault)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setIsDefault(isDefault);
    }
    
    public boolean getIsDefaultHasBeenModified() {
        return _value.getIsDefaultHasBeenModified();
    }
    
    public Integer getSortOrder() {
        return _value.getSortOrder();
    }
    
    public void setSortOrder(Integer sortOrder)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSortOrder(sortOrder);
    }
    
    public boolean getSortOrderHasBeenModified() {
        return _value.getSortOrderHasBeenModified();
    }
    
    public Long getFromTime() {
        return _value.getFromTime();
    }
    
    public void setFromTime(Long fromTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setFromTime(fromTime);
    }
    
    public boolean getFromTimeHasBeenModified() {
        return _value.getFromTimeHasBeenModified();
    }
    
    public Long getThruTime() {
        return _value.getThruTime();
    }
    
    public void setThruTime(Long thruTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setThruTime(thruTime);
    }
    
    public boolean getThruTimeHasBeenModified() {
        return _value.getThruTimeHasBeenModified();
    }
    
}