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

/**
 * TaxDetail.java
 */

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

import com.echothree.model.data.tax.common.pk.TaxDetailPK;

import com.echothree.model.data.tax.common.pk.TaxPK;
import com.echothree.model.data.contact.common.pk.ContactMechanismPurposePK;
import com.echothree.model.data.accounting.common.pk.GlAccountPK;

import com.echothree.model.data.tax.server.entity.Tax;
import com.echothree.model.data.contact.server.entity.ContactMechanismPurpose;
import com.echothree.model.data.accounting.server.entity.GlAccount;

import com.echothree.model.data.tax.server.factory.TaxFactory;
import com.echothree.model.data.contact.server.factory.ContactMechanismPurposeFactory;
import com.echothree.model.data.accounting.server.factory.GlAccountFactory;

import com.echothree.model.data.tax.common.pk.TaxDetailPK;

import com.echothree.model.data.tax.server.value.TaxDetailValue;

import com.echothree.model.data.tax.server.factory.TaxDetailFactory;

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 TaxDetail
        extends BaseEntity
        implements Serializable {
    
    private TaxDetailPK _pk;
    private TaxDetailValue _value;
    
    /** Creates a new instance of TaxDetail */
    public TaxDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of TaxDetail */
    public TaxDetail(TaxDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public TaxDetailFactory getBaseFactoryInstance() {
        return TaxDetailFactory.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 TaxDetail that) {
            TaxDetailValue thatValue = that.getTaxDetailValue();
            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 TaxDetailValue getTaxDetailValue() {
        return _value;
    }
    
    public void setTaxDetailValue(@Nonnull TaxDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public TaxDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public TaxPK getTaxPK() {
        return _value.getTaxPK();
    }
    
    @Nonnull
    public Tax getTax(EntityPermission entityPermission) {
        return TaxFactory.getInstance().getEntityFromPK(entityPermission, getTaxPK());
    }
    
    @Nonnull
    public Tax getTax() {
        return getTax(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Tax getTaxForUpdate() {
        return getTax(EntityPermission.READ_WRITE);
    }
    
    public void setTaxPK(@Nonnull TaxPK taxPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setTaxPK(taxPK);
    }
    
    public void setTax(@Nonnull Tax entity) {
        setTaxPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getTaxPKHasBeenModified() {
        return _value.getTaxPKHasBeenModified();
    }
    
    @Nonnull
    public String getTaxName() {
        return _value.getTaxName();
    }
    
    public void setTaxName(@Nonnull String taxName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setTaxName(taxName);
    }
    
    public boolean getTaxNameHasBeenModified() {
        return _value.getTaxNameHasBeenModified();
    }
    
    @Nonnull
    public ContactMechanismPurposePK getContactMechanismPurposePK() {
        return _value.getContactMechanismPurposePK();
    }
    
    @Nonnull
    public ContactMechanismPurpose getContactMechanismPurpose(EntityPermission entityPermission) {
        return ContactMechanismPurposeFactory.getInstance().getEntityFromPK(entityPermission, getContactMechanismPurposePK());
    }
    
    @Nonnull
    public ContactMechanismPurpose getContactMechanismPurpose() {
        return getContactMechanismPurpose(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public ContactMechanismPurpose getContactMechanismPurposeForUpdate() {
        return getContactMechanismPurpose(EntityPermission.READ_WRITE);
    }
    
    public void setContactMechanismPurposePK(@Nonnull ContactMechanismPurposePK contactMechanismPurposePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setContactMechanismPurposePK(contactMechanismPurposePK);
    }
    
    public void setContactMechanismPurpose(@Nonnull ContactMechanismPurpose entity) {
        setContactMechanismPurposePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getContactMechanismPurposePKHasBeenModified() {
        return _value.getContactMechanismPurposePKHasBeenModified();
    }
    
    @Nonnull
    public GlAccountPK getGlAccountPK() {
        return _value.getGlAccountPK();
    }
    
    @Nonnull
    public GlAccount getGlAccount(EntityPermission entityPermission) {
        return GlAccountFactory.getInstance().getEntityFromPK(entityPermission, getGlAccountPK());
    }
    
    @Nonnull
    public GlAccount getGlAccount() {
        return getGlAccount(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public GlAccount getGlAccountForUpdate() {
        return getGlAccount(EntityPermission.READ_WRITE);
    }
    
    public void setGlAccountPK(@Nonnull GlAccountPK glAccountPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setGlAccountPK(glAccountPK);
    }
    
    public void setGlAccount(@Nonnull GlAccount entity) {
        setGlAccountPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getGlAccountPKHasBeenModified() {
        return _value.getGlAccountPKHasBeenModified();
    }
    
    @Nonnull
    public Boolean getIncludeShippingCharge() {
        return _value.getIncludeShippingCharge();
    }
    
    public void setIncludeShippingCharge(@Nonnull Boolean includeShippingCharge)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setIncludeShippingCharge(includeShippingCharge);
    }
    
    public boolean getIncludeShippingChargeHasBeenModified() {
        return _value.getIncludeShippingChargeHasBeenModified();
    }
    
    @Nonnull
    public Boolean getIncludeProcessingCharge() {
        return _value.getIncludeProcessingCharge();
    }
    
    public void setIncludeProcessingCharge(@Nonnull Boolean includeProcessingCharge)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setIncludeProcessingCharge(includeProcessingCharge);
    }
    
    public boolean getIncludeProcessingChargeHasBeenModified() {
        return _value.getIncludeProcessingChargeHasBeenModified();
    }
    
    @Nonnull
    public Boolean getIncludeInsuranceCharge() {
        return _value.getIncludeInsuranceCharge();
    }
    
    public void setIncludeInsuranceCharge(@Nonnull Boolean includeInsuranceCharge)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setIncludeInsuranceCharge(includeInsuranceCharge);
    }
    
    public boolean getIncludeInsuranceChargeHasBeenModified() {
        return _value.getIncludeInsuranceChargeHasBeenModified();
    }
    
    @Nonnull
    public Integer getPercent() {
        return _value.getPercent();
    }
    
    public void setPercent(@Nonnull Integer percent)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPercent(percent);
    }
    
    public boolean getPercentHasBeenModified() {
        return _value.getPercentHasBeenModified();
    }
    
    @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();
    }
    
}