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

/**
 * OrderLineDetail.java
 */

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

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

import com.echothree.model.data.order.common.pk.OrderLinePK;
import com.echothree.model.data.order.common.pk.OrderPK;
import com.echothree.model.data.order.common.pk.OrderShipmentGroupPK;
import com.echothree.model.data.item.common.pk.ItemPK;
import com.echothree.model.data.inventory.common.pk.InventoryConditionPK;
import com.echothree.model.data.uom.common.pk.UnitOfMeasureTypePK;
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.OrderLine;
import com.echothree.model.data.order.server.entity.Order;
import com.echothree.model.data.order.server.entity.OrderShipmentGroup;
import com.echothree.model.data.item.server.entity.Item;
import com.echothree.model.data.inventory.server.entity.InventoryCondition;
import com.echothree.model.data.uom.server.entity.UnitOfMeasureType;
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.OrderLineFactory;
import com.echothree.model.data.order.server.factory.OrderFactory;
import com.echothree.model.data.order.server.factory.OrderShipmentGroupFactory;
import com.echothree.model.data.item.server.factory.ItemFactory;
import com.echothree.model.data.inventory.server.factory.InventoryConditionFactory;
import com.echothree.model.data.uom.server.factory.UnitOfMeasureTypeFactory;
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.OrderLineDetailPK;

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

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

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 OrderLineDetail
        extends BaseEntity
        implements Serializable {
    
    private OrderLineDetailPK _pk;
    private OrderLineDetailValue _value;
    
    /** Creates a new instance of OrderLineDetail */
    public OrderLineDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of OrderLineDetail */
    public OrderLineDetail(OrderLineDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public OrderLineDetailFactory getBaseFactoryInstance() {
        return OrderLineDetailFactory.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 OrderLineDetail that) {
            OrderLineDetailValue thatValue = that.getOrderLineDetailValue();
            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 OrderLineDetailValue getOrderLineDetailValue() {
        return _value;
    }
    
    public void setOrderLineDetailValue(@Nonnull OrderLineDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public OrderLineDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public OrderLinePK getOrderLinePK() {
        return _value.getOrderLinePK();
    }
    
    @Nonnull
    public OrderLine getOrderLine(EntityPermission entityPermission) {
        return OrderLineFactory.getInstance().getEntityFromPK(entityPermission, getOrderLinePK());
    }
    
    @Nonnull
    public OrderLine getOrderLine() {
        return getOrderLine(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public OrderLine getOrderLineForUpdate() {
        return getOrderLine(EntityPermission.READ_WRITE);
    }
    
    public void setOrderLinePK(@Nonnull OrderLinePK orderLinePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setOrderLinePK(orderLinePK);
    }
    
    public void setOrderLine(@Nonnull OrderLine entity) {
        setOrderLinePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getOrderLinePKHasBeenModified() {
        return _value.getOrderLinePKHasBeenModified();
    }
    
    @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 Integer getOrderLineSequence() {
        return _value.getOrderLineSequence();
    }
    
    public void setOrderLineSequence(@Nonnull Integer orderLineSequence)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setOrderLineSequence(orderLineSequence);
    }
    
    public boolean getOrderLineSequenceHasBeenModified() {
        return _value.getOrderLineSequenceHasBeenModified();
    }
    
    @Nullable
    public OrderLinePK getParentOrderLinePK() {
        return _value.getParentOrderLinePK();
    }
    
    @Nullable
    public OrderLine getParentOrderLine(EntityPermission entityPermission) {
        OrderLinePK pk = getParentOrderLinePK();
        OrderLine entity = pk == null? null: OrderLineFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public OrderLine getParentOrderLine() {
        return getParentOrderLine(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public OrderLine getParentOrderLineForUpdate() {
        return getParentOrderLine(EntityPermission.READ_WRITE);
    }
    
    public void setParentOrderLinePK(@Nullable OrderLinePK parentOrderLinePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setParentOrderLinePK(parentOrderLinePK);
    }
    
    public void setParentOrderLine(@Nullable OrderLine entity) {
        setParentOrderLinePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getParentOrderLinePKHasBeenModified() {
        return _value.getParentOrderLinePKHasBeenModified();
    }
    
    @Nullable
    public OrderShipmentGroupPK getOrderShipmentGroupPK() {
        return _value.getOrderShipmentGroupPK();
    }
    
    @Nullable
    public OrderShipmentGroup getOrderShipmentGroup(EntityPermission entityPermission) {
        OrderShipmentGroupPK pk = getOrderShipmentGroupPK();
        OrderShipmentGroup entity = pk == null? null: OrderShipmentGroupFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public OrderShipmentGroup getOrderShipmentGroup() {
        return getOrderShipmentGroup(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public OrderShipmentGroup getOrderShipmentGroupForUpdate() {
        return getOrderShipmentGroup(EntityPermission.READ_WRITE);
    }
    
    public void setOrderShipmentGroupPK(@Nullable OrderShipmentGroupPK orderShipmentGroupPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setOrderShipmentGroupPK(orderShipmentGroupPK);
    }
    
    public void setOrderShipmentGroup(@Nullable OrderShipmentGroup entity) {
        setOrderShipmentGroupPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getOrderShipmentGroupPKHasBeenModified() {
        return _value.getOrderShipmentGroupPKHasBeenModified();
    }
    
    @Nonnull
    public ItemPK getItemPK() {
        return _value.getItemPK();
    }
    
    @Nonnull
    public Item getItem(EntityPermission entityPermission) {
        return ItemFactory.getInstance().getEntityFromPK(entityPermission, getItemPK());
    }
    
    @Nonnull
    public Item getItem() {
        return getItem(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Item getItemForUpdate() {
        return getItem(EntityPermission.READ_WRITE);
    }
    
    public void setItemPK(@Nonnull ItemPK itemPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setItemPK(itemPK);
    }
    
    public void setItem(@Nonnull Item entity) {
        setItemPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getItemPKHasBeenModified() {
        return _value.getItemPKHasBeenModified();
    }
    
    @Nonnull
    public InventoryConditionPK getInventoryConditionPK() {
        return _value.getInventoryConditionPK();
    }
    
    @Nonnull
    public InventoryCondition getInventoryCondition(EntityPermission entityPermission) {
        return InventoryConditionFactory.getInstance().getEntityFromPK(entityPermission, getInventoryConditionPK());
    }
    
    @Nonnull
    public InventoryCondition getInventoryCondition() {
        return getInventoryCondition(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public InventoryCondition getInventoryConditionForUpdate() {
        return getInventoryCondition(EntityPermission.READ_WRITE);
    }
    
    public void setInventoryConditionPK(@Nonnull InventoryConditionPK inventoryConditionPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setInventoryConditionPK(inventoryConditionPK);
    }
    
    public void setInventoryCondition(@Nonnull InventoryCondition entity) {
        setInventoryConditionPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getInventoryConditionPKHasBeenModified() {
        return _value.getInventoryConditionPKHasBeenModified();
    }
    
    @Nonnull
    public UnitOfMeasureTypePK getUnitOfMeasureTypePK() {
        return _value.getUnitOfMeasureTypePK();
    }
    
    @Nonnull
    public UnitOfMeasureType getUnitOfMeasureType(EntityPermission entityPermission) {
        return UnitOfMeasureTypeFactory.getInstance().getEntityFromPK(entityPermission, getUnitOfMeasureTypePK());
    }
    
    @Nonnull
    public UnitOfMeasureType getUnitOfMeasureType() {
        return getUnitOfMeasureType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public UnitOfMeasureType getUnitOfMeasureTypeForUpdate() {
        return getUnitOfMeasureType(EntityPermission.READ_WRITE);
    }
    
    public void setUnitOfMeasureTypePK(@Nonnull UnitOfMeasureTypePK unitOfMeasureTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUnitOfMeasureTypePK(unitOfMeasureTypePK);
    }
    
    public void setUnitOfMeasureType(@Nonnull UnitOfMeasureType entity) {
        setUnitOfMeasureTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getUnitOfMeasureTypePKHasBeenModified() {
        return _value.getUnitOfMeasureTypePKHasBeenModified();
    }
    
    @Nullable
    public Long getQuantity() {
        return _value.getQuantity();
    }
    
    public void setQuantity(@Nullable Long quantity)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setQuantity(quantity);
    }
    
    public boolean getQuantityHasBeenModified() {
        return _value.getQuantityHasBeenModified();
    }
    
    @Nullable
    public Long getUnitAmount() {
        return _value.getUnitAmount();
    }
    
    public void setUnitAmount(@Nullable Long unitAmount)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUnitAmount(unitAmount);
    }
    
    public boolean getUnitAmountHasBeenModified() {
        return _value.getUnitAmountHasBeenModified();
    }
    
    @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();
    }
    
}