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

/**
 * InvoiceLineDetail.java
 */

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

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

import com.echothree.model.data.invoice.common.pk.InvoiceLinePK;
import com.echothree.model.data.invoice.common.pk.InvoicePK;
import com.echothree.model.data.invoice.common.pk.InvoiceLineTypePK;
import com.echothree.model.data.invoice.common.pk.InvoiceLineUseTypePK;

import com.echothree.model.data.invoice.server.entity.InvoiceLine;
import com.echothree.model.data.invoice.server.entity.Invoice;
import com.echothree.model.data.invoice.server.entity.InvoiceLineType;
import com.echothree.model.data.invoice.server.entity.InvoiceLineUseType;

import com.echothree.model.data.invoice.server.factory.InvoiceLineFactory;
import com.echothree.model.data.invoice.server.factory.InvoiceFactory;
import com.echothree.model.data.invoice.server.factory.InvoiceLineTypeFactory;
import com.echothree.model.data.invoice.server.factory.InvoiceLineUseTypeFactory;

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

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

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

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 InvoiceLineDetail
        extends BaseEntity
        implements Serializable {
    
    private InvoiceLineDetailPK _pk;
    private InvoiceLineDetailValue _value;
    
    /** Creates a new instance of InvoiceLineDetail */
    public InvoiceLineDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of InvoiceLineDetail */
    public InvoiceLineDetail(InvoiceLineDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public InvoiceLineDetailFactory getBaseFactoryInstance() {
        return InvoiceLineDetailFactory.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 InvoiceLineDetail that) {
            InvoiceLineDetailValue thatValue = that.getInvoiceLineDetailValue();
            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 InvoiceLineDetailValue getInvoiceLineDetailValue() {
        return _value;
    }
    
    public void setInvoiceLineDetailValue(@Nonnull InvoiceLineDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public InvoiceLineDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public InvoiceLinePK getInvoiceLinePK() {
        return _value.getInvoiceLinePK();
    }
    
    @Nonnull
    public InvoiceLine getInvoiceLine(EntityPermission entityPermission) {
        return InvoiceLineFactory.getInstance().getEntityFromPK(entityPermission, getInvoiceLinePK());
    }
    
    @Nonnull
    public InvoiceLine getInvoiceLine() {
        return getInvoiceLine(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public InvoiceLine getInvoiceLineForUpdate() {
        return getInvoiceLine(EntityPermission.READ_WRITE);
    }
    
    public void setInvoiceLinePK(@Nonnull InvoiceLinePK invoiceLinePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setInvoiceLinePK(invoiceLinePK);
    }
    
    public void setInvoiceLine(@Nonnull InvoiceLine entity) {
        setInvoiceLinePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getInvoiceLinePKHasBeenModified() {
        return _value.getInvoiceLinePKHasBeenModified();
    }
    
    @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 Integer getInvoiceLineSequence() {
        return _value.getInvoiceLineSequence();
    }
    
    public void setInvoiceLineSequence(@Nonnull Integer invoiceLineSequence)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setInvoiceLineSequence(invoiceLineSequence);
    }
    
    public boolean getInvoiceLineSequenceHasBeenModified() {
        return _value.getInvoiceLineSequenceHasBeenModified();
    }
    
    @Nullable
    public InvoiceLinePK getParentInvoiceLinePK() {
        return _value.getParentInvoiceLinePK();
    }
    
    @Nullable
    public InvoiceLine getParentInvoiceLine(EntityPermission entityPermission) {
        InvoiceLinePK pk = getParentInvoiceLinePK();
        InvoiceLine entity = pk == null? null: InvoiceLineFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public InvoiceLine getParentInvoiceLine() {
        return getParentInvoiceLine(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public InvoiceLine getParentInvoiceLineForUpdate() {
        return getParentInvoiceLine(EntityPermission.READ_WRITE);
    }
    
    public void setParentInvoiceLinePK(@Nullable InvoiceLinePK parentInvoiceLinePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setParentInvoiceLinePK(parentInvoiceLinePK);
    }
    
    public void setParentInvoiceLine(@Nullable InvoiceLine entity) {
        setParentInvoiceLinePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getParentInvoiceLinePKHasBeenModified() {
        return _value.getParentInvoiceLinePKHasBeenModified();
    }
    
    @Nonnull
    public InvoiceLineTypePK getInvoiceLineTypePK() {
        return _value.getInvoiceLineTypePK();
    }
    
    @Nonnull
    public InvoiceLineType getInvoiceLineType(EntityPermission entityPermission) {
        return InvoiceLineTypeFactory.getInstance().getEntityFromPK(entityPermission, getInvoiceLineTypePK());
    }
    
    @Nonnull
    public InvoiceLineType getInvoiceLineType() {
        return getInvoiceLineType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public InvoiceLineType getInvoiceLineTypeForUpdate() {
        return getInvoiceLineType(EntityPermission.READ_WRITE);
    }
    
    public void setInvoiceLineTypePK(@Nonnull InvoiceLineTypePK invoiceLineTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setInvoiceLineTypePK(invoiceLineTypePK);
    }
    
    public void setInvoiceLineType(@Nonnull InvoiceLineType entity) {
        setInvoiceLineTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getInvoiceLineTypePKHasBeenModified() {
        return _value.getInvoiceLineTypePKHasBeenModified();
    }
    
    @Nonnull
    public InvoiceLineUseTypePK getInvoiceLineUseTypePK() {
        return _value.getInvoiceLineUseTypePK();
    }
    
    @Nonnull
    public InvoiceLineUseType getInvoiceLineUseType(EntityPermission entityPermission) {
        return InvoiceLineUseTypeFactory.getInstance().getEntityFromPK(entityPermission, getInvoiceLineUseTypePK());
    }
    
    @Nonnull
    public InvoiceLineUseType getInvoiceLineUseType() {
        return getInvoiceLineUseType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public InvoiceLineUseType getInvoiceLineUseTypeForUpdate() {
        return getInvoiceLineUseType(EntityPermission.READ_WRITE);
    }
    
    public void setInvoiceLineUseTypePK(@Nonnull InvoiceLineUseTypePK invoiceLineUseTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setInvoiceLineUseTypePK(invoiceLineUseTypePK);
    }
    
    public void setInvoiceLineUseType(@Nonnull InvoiceLineUseType entity) {
        setInvoiceLineUseTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getInvoiceLineUseTypePKHasBeenModified() {
        return _value.getInvoiceLineUseTypePKHasBeenModified();
    }
    
    @Nonnull
    public Long getAmount() {
        return _value.getAmount();
    }
    
    public void setAmount(@Nonnull Long amount)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAmount(amount);
    }
    
    public boolean getAmountHasBeenModified() {
        return _value.getAmountHasBeenModified();
    }
    
    @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();
    }
    
}