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

/**
 * InvoiceDetail.java
 */

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

import com.echothree.model.data.invoice.common.pk.InvoiceDetailPK;

import com.echothree.model.data.invoice.common.pk.InvoicePK;
import com.echothree.model.data.invoice.common.pk.InvoiceTypePK;
import com.echothree.model.data.payment.common.pk.BillingAccountPK;
import com.echothree.model.data.accounting.common.pk.GlAccountPK;
import com.echothree.model.data.term.common.pk.TermPK;
import com.echothree.model.data.shipment.common.pk.FreeOnBoardPK;

import com.echothree.model.data.invoice.server.entity.Invoice;
import com.echothree.model.data.invoice.server.entity.InvoiceType;
import com.echothree.model.data.payment.server.entity.BillingAccount;
import com.echothree.model.data.accounting.server.entity.GlAccount;
import com.echothree.model.data.term.server.entity.Term;
import com.echothree.model.data.shipment.server.entity.FreeOnBoard;

import com.echothree.model.data.invoice.server.factory.InvoiceFactory;
import com.echothree.model.data.invoice.server.factory.InvoiceTypeFactory;
import com.echothree.model.data.payment.server.factory.BillingAccountFactory;
import com.echothree.model.data.accounting.server.factory.GlAccountFactory;
import com.echothree.model.data.term.server.factory.TermFactory;
import com.echothree.model.data.shipment.server.factory.FreeOnBoardFactory;

import com.echothree.model.data.invoice.common.pk.InvoiceDetailPK;

import com.echothree.model.data.invoice.server.value.InvoiceDetailValue;

import com.echothree.model.data.invoice.server.factory.InvoiceDetailFactory;

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 InvoiceDetail
        extends BaseEntity
        implements Serializable {
    
    private InvoiceDetailPK _pk;
    private InvoiceDetailValue _value;
    
    /** Creates a new instance of InvoiceDetail */
    public InvoiceDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of InvoiceDetail */
    public InvoiceDetail(InvoiceDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public InvoiceDetailFactory getBaseFactoryInstance() {
        return InvoiceDetailFactory.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 InvoiceDetail that) {
            InvoiceDetailValue thatValue = that.getInvoiceDetailValue();
            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 InvoiceDetailValue getInvoiceDetailValue() {
        return _value;
    }
    
    public void setInvoiceDetailValue(@Nonnull InvoiceDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public InvoiceDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public InvoicePK getInvoicePK() {
        return _value.getInvoicePK();
    }
    
    @Nonnull
    public Invoice getInvoice(EntityPermission entityPermission) {
        return InvoiceFactory.getInstance().getEntityFromPK(entityPermission, getInvoicePK());
    }
    
    @Nonnull
    public Invoice getInvoice() {
        return getInvoice(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Invoice getInvoiceForUpdate() {
        return getInvoice(EntityPermission.READ_WRITE);
    }
    
    public void setInvoicePK(@Nonnull InvoicePK invoicePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setInvoicePK(invoicePK);
    }
    
    public void setInvoice(@Nonnull Invoice entity) {
        setInvoicePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getInvoicePKHasBeenModified() {
        return _value.getInvoicePKHasBeenModified();
    }
    
    @Nonnull
    public InvoiceTypePK getInvoiceTypePK() {
        return _value.getInvoiceTypePK();
    }
    
    @Nonnull
    public InvoiceType getInvoiceType(EntityPermission entityPermission) {
        return InvoiceTypeFactory.getInstance().getEntityFromPK(entityPermission, getInvoiceTypePK());
    }
    
    @Nonnull
    public InvoiceType getInvoiceType() {
        return getInvoiceType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public InvoiceType getInvoiceTypeForUpdate() {
        return getInvoiceType(EntityPermission.READ_WRITE);
    }
    
    public void setInvoiceTypePK(@Nonnull InvoiceTypePK invoiceTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setInvoiceTypePK(invoiceTypePK);
    }
    
    public void setInvoiceType(@Nonnull InvoiceType entity) {
        setInvoiceTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getInvoiceTypePKHasBeenModified() {
        return _value.getInvoiceTypePKHasBeenModified();
    }
    
    @Nonnull
    public String getInvoiceName() {
        return _value.getInvoiceName();
    }
    
    public void setInvoiceName(@Nonnull String invoiceName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setInvoiceName(invoiceName);
    }
    
    public boolean getInvoiceNameHasBeenModified() {
        return _value.getInvoiceNameHasBeenModified();
    }
    
    @Nonnull
    public BillingAccountPK getBillingAccountPK() {
        return _value.getBillingAccountPK();
    }
    
    @Nonnull
    public BillingAccount getBillingAccount(EntityPermission entityPermission) {
        return BillingAccountFactory.getInstance().getEntityFromPK(entityPermission, getBillingAccountPK());
    }
    
    @Nonnull
    public BillingAccount getBillingAccount() {
        return getBillingAccount(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public BillingAccount getBillingAccountForUpdate() {
        return getBillingAccount(EntityPermission.READ_WRITE);
    }
    
    public void setBillingAccountPK(@Nonnull BillingAccountPK billingAccountPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setBillingAccountPK(billingAccountPK);
    }
    
    public void setBillingAccount(@Nonnull BillingAccount entity) {
        setBillingAccountPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getBillingAccountPKHasBeenModified() {
        return _value.getBillingAccountPKHasBeenModified();
    }
    
    @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 TermPK getTermPK() {
        return _value.getTermPK();
    }
    
    @Nonnull
    public Term getTerm(EntityPermission entityPermission) {
        return TermFactory.getInstance().getEntityFromPK(entityPermission, getTermPK());
    }
    
    @Nonnull
    public Term getTerm() {
        return getTerm(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Term getTermForUpdate() {
        return getTerm(EntityPermission.READ_WRITE);
    }
    
    public void setTermPK(@Nonnull TermPK termPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setTermPK(termPK);
    }
    
    public void setTerm(@Nonnull Term entity) {
        setTermPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getTermPKHasBeenModified() {
        return _value.getTermPKHasBeenModified();
    }
    
    @Nullable
    public FreeOnBoardPK getFreeOnBoardPK() {
        return _value.getFreeOnBoardPK();
    }
    
    @Nullable
    public FreeOnBoard getFreeOnBoard(EntityPermission entityPermission) {
        FreeOnBoardPK pk = getFreeOnBoardPK();
        FreeOnBoard entity = pk == null? null: FreeOnBoardFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public FreeOnBoard getFreeOnBoard() {
        return getFreeOnBoard(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public FreeOnBoard getFreeOnBoardForUpdate() {
        return getFreeOnBoard(EntityPermission.READ_WRITE);
    }
    
    public void setFreeOnBoardPK(@Nullable FreeOnBoardPK freeOnBoardPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setFreeOnBoardPK(freeOnBoardPK);
    }
    
    public void setFreeOnBoard(@Nullable FreeOnBoard entity) {
        setFreeOnBoardPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getFreeOnBoardPKHasBeenModified() {
        return _value.getFreeOnBoardPKHasBeenModified();
    }
    
    @Nullable
    public String getReference() {
        return _value.getReference();
    }
    
    public void setReference(@Nullable String reference)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setReference(reference);
    }
    
    public boolean getReferenceHasBeenModified() {
        return _value.getReferenceHasBeenModified();
    }
    
    @Nullable
    public String getDescription() {
        return _value.getDescription();
    }
    
    public void setDescription(@Nullable String description)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setDescription(description);
    }
    
    public boolean getDescriptionHasBeenModified() {
        return _value.getDescriptionHasBeenModified();
    }
    
    @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();
    }
    
}