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

/**
 * ShipmentLineDetail.java
 */

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

import com.echothree.model.data.shipment.common.pk.ShipmentLineDetailPK;

import com.echothree.model.data.shipment.common.pk.ShipmentLinePK;
import com.echothree.model.data.shipment.common.pk.ShipmentPK;
import com.echothree.model.data.order.common.pk.OrderLinePK;
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.shipment.server.entity.ShipmentLine;
import com.echothree.model.data.shipment.server.entity.Shipment;
import com.echothree.model.data.order.server.entity.OrderLine;
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.shipment.server.factory.ShipmentLineFactory;
import com.echothree.model.data.shipment.server.factory.ShipmentFactory;
import com.echothree.model.data.order.server.factory.OrderLineFactory;
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.shipment.common.pk.ShipmentLineDetailPK;

import com.echothree.model.data.shipment.server.value.ShipmentLineDetailValue;

import com.echothree.model.data.shipment.server.factory.ShipmentLineDetailFactory;

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 ShipmentLineDetail
        extends BaseEntity
        implements Serializable {
    
    private ShipmentLineDetailPK _pk;
    private ShipmentLineDetailValue _value;
    
    /** Creates a new instance of ShipmentLineDetail */
    public ShipmentLineDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of ShipmentLineDetail */
    public ShipmentLineDetail(ShipmentLineDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public ShipmentLineDetailFactory getBaseFactoryInstance() {
        return ShipmentLineDetailFactory.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 ShipmentLineDetail that) {
            ShipmentLineDetailValue thatValue = that.getShipmentLineDetailValue();
            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 ShipmentLineDetailValue getShipmentLineDetailValue() {
        return _value;
    }
    
    public void setShipmentLineDetailValue(@Nonnull ShipmentLineDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public ShipmentLineDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public ShipmentLinePK getShipmentLinePK() {
        return _value.getShipmentLinePK();
    }
    
    @Nonnull
    public ShipmentLine getShipmentLine(EntityPermission entityPermission) {
        return ShipmentLineFactory.getInstance().getEntityFromPK(entityPermission, getShipmentLinePK());
    }
    
    @Nonnull
    public ShipmentLine getShipmentLine() {
        return getShipmentLine(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public ShipmentLine getShipmentLineForUpdate() {
        return getShipmentLine(EntityPermission.READ_WRITE);
    }
    
    public void setShipmentLinePK(@Nonnull ShipmentLinePK shipmentLinePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setShipmentLinePK(shipmentLinePK);
    }
    
    public void setShipmentLine(@Nonnull ShipmentLine entity) {
        setShipmentLinePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getShipmentLinePKHasBeenModified() {
        return _value.getShipmentLinePKHasBeenModified();
    }
    
    @Nonnull
    public ShipmentPK getShipmentPK() {
        return _value.getShipmentPK();
    }
    
    @Nonnull
    public Shipment getShipment(EntityPermission entityPermission) {
        return ShipmentFactory.getInstance().getEntityFromPK(entityPermission, getShipmentPK());
    }
    
    @Nonnull
    public Shipment getShipment() {
        return getShipment(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Shipment getShipmentForUpdate() {
        return getShipment(EntityPermission.READ_WRITE);
    }
    
    public void setShipmentPK(@Nonnull ShipmentPK shipmentPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setShipmentPK(shipmentPK);
    }
    
    public void setShipment(@Nonnull Shipment entity) {
        setShipmentPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getShipmentPKHasBeenModified() {
        return _value.getShipmentPKHasBeenModified();
    }
    
    @Nonnull
    public Integer getShipmentLineSequence() {
        return _value.getShipmentLineSequence();
    }
    
    public void setShipmentLineSequence(@Nonnull Integer shipmentLineSequence)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setShipmentLineSequence(shipmentLineSequence);
    }
    
    public boolean getShipmentLineSequenceHasBeenModified() {
        return _value.getShipmentLineSequenceHasBeenModified();
    }
    
    @Nullable
    public ShipmentLinePK getParentShipmentLinePK() {
        return _value.getParentShipmentLinePK();
    }
    
    @Nullable
    public ShipmentLine getParentShipmentLine(EntityPermission entityPermission) {
        ShipmentLinePK pk = getParentShipmentLinePK();
        ShipmentLine entity = pk == null? null: ShipmentLineFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public ShipmentLine getParentShipmentLine() {
        return getParentShipmentLine(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public ShipmentLine getParentShipmentLineForUpdate() {
        return getParentShipmentLine(EntityPermission.READ_WRITE);
    }
    
    public void setParentShipmentLinePK(@Nullable ShipmentLinePK parentShipmentLinePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setParentShipmentLinePK(parentShipmentLinePK);
    }
    
    public void setParentShipmentLine(@Nullable ShipmentLine entity) {
        setParentShipmentLinePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getParentShipmentLinePKHasBeenModified() {
        return _value.getParentShipmentLinePKHasBeenModified();
    }
    
    @Nullable
    public OrderLinePK getOrderLinePK() {
        return _value.getOrderLinePK();
    }
    
    @Nullable
    public OrderLine getOrderLine(EntityPermission entityPermission) {
        OrderLinePK pk = getOrderLinePK();
        OrderLine entity = pk == null? null: OrderLineFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public OrderLine getOrderLine() {
        return getOrderLine(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public OrderLine getOrderLineForUpdate() {
        return getOrderLine(EntityPermission.READ_WRITE);
    }
    
    public void setOrderLinePK(@Nullable OrderLinePK orderLinePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setOrderLinePK(orderLinePK);
    }
    
    public void setOrderLine(@Nullable OrderLine entity) {
        setOrderLinePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getOrderLinePKHasBeenModified() {
        return _value.getOrderLinePKHasBeenModified();
    }
    
    @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();
    }
    
    @Nonnull
    public Long getQuantity() {
        return _value.getQuantity();
    }
    
    public void setQuantity(@Nonnull Long quantity)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setQuantity(quantity);
    }
    
    public boolean getQuantityHasBeenModified() {
        return _value.getQuantityHasBeenModified();
    }
    
    @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();
    }
    
}