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

/**
 * ShipmentPackageLineDetail.java
 */

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

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

import com.echothree.model.data.shipment.common.pk.ShipmentPackageLinePK;
import com.echothree.model.data.shipment.common.pk.ShipmentPackagePK;
import com.echothree.model.data.shipment.common.pk.ShipmentLinePK;
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.ShipmentPackageLine;
import com.echothree.model.data.shipment.server.entity.ShipmentPackage;
import com.echothree.model.data.shipment.server.entity.ShipmentLine;
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.ShipmentPackageLineFactory;
import com.echothree.model.data.shipment.server.factory.ShipmentPackageFactory;
import com.echothree.model.data.shipment.server.factory.ShipmentLineFactory;
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.ShipmentPackageLineDetailPK;

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

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

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 ShipmentPackageLineDetail
        extends BaseEntity
        implements Serializable {
    
    private ShipmentPackageLineDetailPK _pk;
    private ShipmentPackageLineDetailValue _value;
    
    /** Creates a new instance of ShipmentPackageLineDetail */
    public ShipmentPackageLineDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of ShipmentPackageLineDetail */
    public ShipmentPackageLineDetail(ShipmentPackageLineDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public ShipmentPackageLineDetailFactory getBaseFactoryInstance() {
        return ShipmentPackageLineDetailFactory.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 ShipmentPackageLineDetail that) {
            ShipmentPackageLineDetailValue thatValue = that.getShipmentPackageLineDetailValue();
            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 ShipmentPackageLineDetailValue getShipmentPackageLineDetailValue() {
        return _value;
    }
    
    public void setShipmentPackageLineDetailValue(@Nonnull ShipmentPackageLineDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public ShipmentPackageLineDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public ShipmentPackageLinePK getShipmentPackageLinePK() {
        return _value.getShipmentPackageLinePK();
    }
    
    @Nonnull
    public ShipmentPackageLine getShipmentPackageLine(EntityPermission entityPermission) {
        return ShipmentPackageLineFactory.getInstance().getEntityFromPK(entityPermission, getShipmentPackageLinePK());
    }
    
    @Nonnull
    public ShipmentPackageLine getShipmentPackageLine() {
        return getShipmentPackageLine(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public ShipmentPackageLine getShipmentPackageLineForUpdate() {
        return getShipmentPackageLine(EntityPermission.READ_WRITE);
    }
    
    public void setShipmentPackageLinePK(@Nonnull ShipmentPackageLinePK shipmentPackageLinePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setShipmentPackageLinePK(shipmentPackageLinePK);
    }
    
    public void setShipmentPackageLine(@Nonnull ShipmentPackageLine entity) {
        setShipmentPackageLinePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getShipmentPackageLinePKHasBeenModified() {
        return _value.getShipmentPackageLinePKHasBeenModified();
    }
    
    @Nonnull
    public ShipmentPackagePK getShipmentPackagePK() {
        return _value.getShipmentPackagePK();
    }
    
    @Nonnull
    public ShipmentPackage getShipmentPackage(EntityPermission entityPermission) {
        return ShipmentPackageFactory.getInstance().getEntityFromPK(entityPermission, getShipmentPackagePK());
    }
    
    @Nonnull
    public ShipmentPackage getShipmentPackage() {
        return getShipmentPackage(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public ShipmentPackage getShipmentPackageForUpdate() {
        return getShipmentPackage(EntityPermission.READ_WRITE);
    }
    
    public void setShipmentPackagePK(@Nonnull ShipmentPackagePK shipmentPackagePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setShipmentPackagePK(shipmentPackagePK);
    }
    
    public void setShipmentPackage(@Nonnull ShipmentPackage entity) {
        setShipmentPackagePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getShipmentPackagePKHasBeenModified() {
        return _value.getShipmentPackagePKHasBeenModified();
    }
    
    @Nonnull
    public Integer getShipmentPackageLineSequence() {
        return _value.getShipmentPackageLineSequence();
    }
    
    public void setShipmentPackageLineSequence(@Nonnull Integer shipmentPackageLineSequence)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setShipmentPackageLineSequence(shipmentPackageLineSequence);
    }
    
    public boolean getShipmentPackageLineSequenceHasBeenModified() {
        return _value.getShipmentPackageLineSequenceHasBeenModified();
    }
    
    @Nullable
    public ShipmentLinePK getShipmentLinePK() {
        return _value.getShipmentLinePK();
    }
    
    @Nullable
    public ShipmentLine getShipmentLine(EntityPermission entityPermission) {
        ShipmentLinePK pk = getShipmentLinePK();
        ShipmentLine entity = pk == null? null: ShipmentLineFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public ShipmentLine getShipmentLine() {
        return getShipmentLine(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public ShipmentLine getShipmentLineForUpdate() {
        return getShipmentLine(EntityPermission.READ_WRITE);
    }
    
    public void setShipmentLinePK(@Nullable ShipmentLinePK shipmentLinePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setShipmentLinePK(shipmentLinePK);
    }
    
    public void setShipmentLine(@Nullable ShipmentLine entity) {
        setShipmentLinePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getShipmentLinePKHasBeenModified() {
        return _value.getShipmentLinePKHasBeenModified();
    }
    
    @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();
    }
    
}