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

/**
 * OrderDetail.java
 */

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

import com.echothree.model.data.order.common.pk.OrderDetailPK;

import com.echothree.model.data.order.common.pk.OrderPK;
import com.echothree.model.data.order.common.pk.OrderTypePK;
import com.echothree.model.data.order.common.pk.OrderPriorityPK;
import com.echothree.model.data.accounting.common.pk.CurrencyPK;
import com.echothree.model.data.term.common.pk.TermPK;
import com.echothree.model.data.shipment.common.pk.FreeOnBoardPK;
import com.echothree.model.data.cancellationpolicy.common.pk.CancellationPolicyPK;
import com.echothree.model.data.returnpolicy.common.pk.ReturnPolicyPK;

import com.echothree.model.data.order.server.entity.Order;
import com.echothree.model.data.order.server.entity.OrderType;
import com.echothree.model.data.order.server.entity.OrderPriority;
import com.echothree.model.data.accounting.server.entity.Currency;
import com.echothree.model.data.term.server.entity.Term;
import com.echothree.model.data.shipment.server.entity.FreeOnBoard;
import com.echothree.model.data.cancellationpolicy.server.entity.CancellationPolicy;
import com.echothree.model.data.returnpolicy.server.entity.ReturnPolicy;

import com.echothree.model.data.order.server.factory.OrderFactory;
import com.echothree.model.data.order.server.factory.OrderTypeFactory;
import com.echothree.model.data.order.server.factory.OrderPriorityFactory;
import com.echothree.model.data.accounting.server.factory.CurrencyFactory;
import com.echothree.model.data.term.server.factory.TermFactory;
import com.echothree.model.data.shipment.server.factory.FreeOnBoardFactory;
import com.echothree.model.data.cancellationpolicy.server.factory.CancellationPolicyFactory;
import com.echothree.model.data.returnpolicy.server.factory.ReturnPolicyFactory;

import com.echothree.model.data.order.common.pk.OrderDetailPK;

import com.echothree.model.data.order.server.value.OrderDetailValue;

import com.echothree.model.data.order.server.factory.OrderDetailFactory;

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 OrderDetail
        extends BaseEntity
        implements Serializable {
    
    private OrderDetailPK _pk;
    private OrderDetailValue _value;
    
    /** Creates a new instance of OrderDetail */
    public OrderDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of OrderDetail */
    public OrderDetail(OrderDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public OrderDetailFactory getBaseFactoryInstance() {
        return OrderDetailFactory.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 OrderDetail that) {
            OrderDetailValue thatValue = that.getOrderDetailValue();
            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 OrderDetailValue getOrderDetailValue() {
        return _value;
    }
    
    public void setOrderDetailValue(@Nonnull OrderDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public OrderDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public OrderPK getOrderPK() {
        return _value.getOrderPK();
    }
    
    @Nonnull
    public Order getOrder(EntityPermission entityPermission) {
        return OrderFactory.getInstance().getEntityFromPK(entityPermission, getOrderPK());
    }
    
    @Nonnull
    public Order getOrder() {
        return getOrder(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Order getOrderForUpdate() {
        return getOrder(EntityPermission.READ_WRITE);
    }
    
    public void setOrderPK(@Nonnull OrderPK orderPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setOrderPK(orderPK);
    }
    
    public void setOrder(@Nonnull Order entity) {
        setOrderPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getOrderPKHasBeenModified() {
        return _value.getOrderPKHasBeenModified();
    }
    
    @Nonnull
    public OrderTypePK getOrderTypePK() {
        return _value.getOrderTypePK();
    }
    
    @Nonnull
    public OrderType getOrderType(EntityPermission entityPermission) {
        return OrderTypeFactory.getInstance().getEntityFromPK(entityPermission, getOrderTypePK());
    }
    
    @Nonnull
    public OrderType getOrderType() {
        return getOrderType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public OrderType getOrderTypeForUpdate() {
        return getOrderType(EntityPermission.READ_WRITE);
    }
    
    public void setOrderTypePK(@Nonnull OrderTypePK orderTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setOrderTypePK(orderTypePK);
    }
    
    public void setOrderType(@Nonnull OrderType entity) {
        setOrderTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getOrderTypePKHasBeenModified() {
        return _value.getOrderTypePKHasBeenModified();
    }
    
    @Nonnull
    public String getOrderName() {
        return _value.getOrderName();
    }
    
    public void setOrderName(@Nonnull String orderName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setOrderName(orderName);
    }
    
    public boolean getOrderNameHasBeenModified() {
        return _value.getOrderNameHasBeenModified();
    }
    
    @Nullable
    public OrderPriorityPK getOrderPriorityPK() {
        return _value.getOrderPriorityPK();
    }
    
    @Nullable
    public OrderPriority getOrderPriority(EntityPermission entityPermission) {
        OrderPriorityPK pk = getOrderPriorityPK();
        OrderPriority entity = pk == null? null: OrderPriorityFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public OrderPriority getOrderPriority() {
        return getOrderPriority(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public OrderPriority getOrderPriorityForUpdate() {
        return getOrderPriority(EntityPermission.READ_WRITE);
    }
    
    public void setOrderPriorityPK(@Nullable OrderPriorityPK orderPriorityPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setOrderPriorityPK(orderPriorityPK);
    }
    
    public void setOrderPriority(@Nullable OrderPriority entity) {
        setOrderPriorityPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getOrderPriorityPKHasBeenModified() {
        return _value.getOrderPriorityPKHasBeenModified();
    }
    
    @Nonnull
    public CurrencyPK getCurrencyPK() {
        return _value.getCurrencyPK();
    }
    
    @Nonnull
    public Currency getCurrency(EntityPermission entityPermission) {
        return CurrencyFactory.getInstance().getEntityFromPK(entityPermission, getCurrencyPK());
    }
    
    @Nonnull
    public Currency getCurrency() {
        return getCurrency(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Currency getCurrencyForUpdate() {
        return getCurrency(EntityPermission.READ_WRITE);
    }
    
    public void setCurrencyPK(@Nonnull CurrencyPK currencyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCurrencyPK(currencyPK);
    }
    
    public void setCurrency(@Nonnull Currency entity) {
        setCurrencyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCurrencyPKHasBeenModified() {
        return _value.getCurrencyPKHasBeenModified();
    }
    
    @Nullable
    public Boolean getHoldUntilComplete() {
        return _value.getHoldUntilComplete();
    }
    
    public void setHoldUntilComplete(@Nullable Boolean holdUntilComplete)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setHoldUntilComplete(holdUntilComplete);
    }
    
    public boolean getHoldUntilCompleteHasBeenModified() {
        return _value.getHoldUntilCompleteHasBeenModified();
    }
    
    @Nullable
    public Boolean getAllowBackorders() {
        return _value.getAllowBackorders();
    }
    
    public void setAllowBackorders(@Nullable Boolean allowBackorders)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAllowBackorders(allowBackorders);
    }
    
    public boolean getAllowBackordersHasBeenModified() {
        return _value.getAllowBackordersHasBeenModified();
    }
    
    @Nullable
    public Boolean getAllowSubstitutions() {
        return _value.getAllowSubstitutions();
    }
    
    public void setAllowSubstitutions(@Nullable Boolean allowSubstitutions)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAllowSubstitutions(allowSubstitutions);
    }
    
    public boolean getAllowSubstitutionsHasBeenModified() {
        return _value.getAllowSubstitutionsHasBeenModified();
    }
    
    @Nullable
    public Boolean getAllowCombiningShipments() {
        return _value.getAllowCombiningShipments();
    }
    
    public void setAllowCombiningShipments(@Nullable Boolean allowCombiningShipments)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAllowCombiningShipments(allowCombiningShipments);
    }
    
    public boolean getAllowCombiningShipmentsHasBeenModified() {
        return _value.getAllowCombiningShipmentsHasBeenModified();
    }
    
    @Nullable
    public TermPK getTermPK() {
        return _value.getTermPK();
    }
    
    @Nullable
    public Term getTerm(EntityPermission entityPermission) {
        TermPK pk = getTermPK();
        Term entity = pk == null? null: TermFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Term getTerm() {
        return getTerm(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Term getTermForUpdate() {
        return getTerm(EntityPermission.READ_WRITE);
    }
    
    public void setTermPK(@Nullable TermPK termPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setTermPK(termPK);
    }
    
    public void setTerm(@Nullable 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();
    }
    
    @Nullable
    public CancellationPolicyPK getCancellationPolicyPK() {
        return _value.getCancellationPolicyPK();
    }
    
    @Nullable
    public CancellationPolicy getCancellationPolicy(EntityPermission entityPermission) {
        CancellationPolicyPK pk = getCancellationPolicyPK();
        CancellationPolicy entity = pk == null? null: CancellationPolicyFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public CancellationPolicy getCancellationPolicy() {
        return getCancellationPolicy(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public CancellationPolicy getCancellationPolicyForUpdate() {
        return getCancellationPolicy(EntityPermission.READ_WRITE);
    }
    
    public void setCancellationPolicyPK(@Nullable CancellationPolicyPK cancellationPolicyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCancellationPolicyPK(cancellationPolicyPK);
    }
    
    public void setCancellationPolicy(@Nullable CancellationPolicy entity) {
        setCancellationPolicyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCancellationPolicyPKHasBeenModified() {
        return _value.getCancellationPolicyPKHasBeenModified();
    }
    
    @Nullable
    public ReturnPolicyPK getReturnPolicyPK() {
        return _value.getReturnPolicyPK();
    }
    
    @Nullable
    public ReturnPolicy getReturnPolicy(EntityPermission entityPermission) {
        ReturnPolicyPK pk = getReturnPolicyPK();
        ReturnPolicy entity = pk == null? null: ReturnPolicyFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public ReturnPolicy getReturnPolicy() {
        return getReturnPolicy(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public ReturnPolicy getReturnPolicyForUpdate() {
        return getReturnPolicy(EntityPermission.READ_WRITE);
    }
    
    public void setReturnPolicyPK(@Nullable ReturnPolicyPK returnPolicyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setReturnPolicyPK(returnPolicyPK);
    }
    
    public void setReturnPolicy(@Nullable ReturnPolicy entity) {
        setReturnPolicyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getReturnPolicyPKHasBeenModified() {
        return _value.getReturnPolicyPKHasBeenModified();
    }
    
    @Nullable
    public Boolean getTaxable() {
        return _value.getTaxable();
    }
    
    public void setTaxable(@Nullable Boolean taxable)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setTaxable(taxable);
    }
    
    public boolean getTaxableHasBeenModified() {
        return _value.getTaxableHasBeenModified();
    }
    
    @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();
    }
    
}