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

/**
 * ShipmentPackageDetail.java
 */

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

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

import com.echothree.model.data.shipment.common.pk.ShipmentPackagePK;
import com.echothree.model.data.shipment.common.pk.ShipmentTypePK;
import com.echothree.model.data.shipment.common.pk.ShipmentPK;
import com.echothree.model.data.warehouse.common.pk.PackageTypePK;
import com.echothree.model.data.uom.common.pk.UnitOfMeasureTypePK;

import com.echothree.model.data.shipment.server.entity.ShipmentPackage;
import com.echothree.model.data.shipment.server.entity.ShipmentType;
import com.echothree.model.data.shipment.server.entity.Shipment;
import com.echothree.model.data.warehouse.server.entity.PackageType;
import com.echothree.model.data.uom.server.entity.UnitOfMeasureType;

import com.echothree.model.data.shipment.server.factory.ShipmentPackageFactory;
import com.echothree.model.data.shipment.server.factory.ShipmentTypeFactory;
import com.echothree.model.data.shipment.server.factory.ShipmentFactory;
import com.echothree.model.data.warehouse.server.factory.PackageTypeFactory;
import com.echothree.model.data.uom.server.factory.UnitOfMeasureTypeFactory;

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

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

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

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 ShipmentPackageDetail
        extends BaseEntity
        implements Serializable {
    
    private ShipmentPackageDetailPK _pk;
    private ShipmentPackageDetailValue _value;
    
    /** Creates a new instance of ShipmentPackageDetail */
    public ShipmentPackageDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of ShipmentPackageDetail */
    public ShipmentPackageDetail(ShipmentPackageDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public ShipmentPackageDetailFactory getBaseFactoryInstance() {
        return ShipmentPackageDetailFactory.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 ShipmentPackageDetail that) {
            ShipmentPackageDetailValue thatValue = that.getShipmentPackageDetailValue();
            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 ShipmentPackageDetailValue getShipmentPackageDetailValue() {
        return _value;
    }
    
    public void setShipmentPackageDetailValue(@Nonnull ShipmentPackageDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public ShipmentPackageDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @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 ShipmentTypePK getShipmentTypePK() {
        return _value.getShipmentTypePK();
    }
    
    @Nonnull
    public ShipmentType getShipmentType(EntityPermission entityPermission) {
        return ShipmentTypeFactory.getInstance().getEntityFromPK(entityPermission, getShipmentTypePK());
    }
    
    @Nonnull
    public ShipmentType getShipmentType() {
        return getShipmentType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public ShipmentType getShipmentTypeForUpdate() {
        return getShipmentType(EntityPermission.READ_WRITE);
    }
    
    public void setShipmentTypePK(@Nonnull ShipmentTypePK shipmentTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setShipmentTypePK(shipmentTypePK);
    }
    
    public void setShipmentType(@Nonnull ShipmentType entity) {
        setShipmentTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getShipmentTypePKHasBeenModified() {
        return _value.getShipmentTypePKHasBeenModified();
    }
    
    @Nonnull
    public String getShipmentPackageName() {
        return _value.getShipmentPackageName();
    }
    
    public void setShipmentPackageName(@Nonnull String shipmentPackageName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setShipmentPackageName(shipmentPackageName);
    }
    
    public boolean getShipmentPackageNameHasBeenModified() {
        return _value.getShipmentPackageNameHasBeenModified();
    }
    
    @Nullable
    public ShipmentPackagePK getParentShipmentPackagePK() {
        return _value.getParentShipmentPackagePK();
    }
    
    @Nullable
    public ShipmentPackage getParentShipmentPackage(EntityPermission entityPermission) {
        ShipmentPackagePK pk = getParentShipmentPackagePK();
        ShipmentPackage entity = pk == null? null: ShipmentPackageFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public ShipmentPackage getParentShipmentPackage() {
        return getParentShipmentPackage(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public ShipmentPackage getParentShipmentPackageForUpdate() {
        return getParentShipmentPackage(EntityPermission.READ_WRITE);
    }
    
    public void setParentShipmentPackagePK(@Nullable ShipmentPackagePK parentShipmentPackagePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setParentShipmentPackagePK(parentShipmentPackagePK);
    }
    
    public void setParentShipmentPackage(@Nullable ShipmentPackage entity) {
        setParentShipmentPackagePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getParentShipmentPackagePKHasBeenModified() {
        return _value.getParentShipmentPackagePKHasBeenModified();
    }
    
    @Nullable
    public ShipmentPK getShipmentPK() {
        return _value.getShipmentPK();
    }
    
    @Nullable
    public Shipment getShipment(EntityPermission entityPermission) {
        ShipmentPK pk = getShipmentPK();
        Shipment entity = pk == null? null: ShipmentFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Shipment getShipment() {
        return getShipment(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Shipment getShipmentForUpdate() {
        return getShipment(EntityPermission.READ_WRITE);
    }
    
    public void setShipmentPK(@Nullable ShipmentPK shipmentPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setShipmentPK(shipmentPK);
    }
    
    public void setShipment(@Nullable Shipment entity) {
        setShipmentPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getShipmentPKHasBeenModified() {
        return _value.getShipmentPKHasBeenModified();
    }
    
    @Nullable
    public PackageTypePK getPackageTypePK() {
        return _value.getPackageTypePK();
    }
    
    @Nullable
    public PackageType getPackageType(EntityPermission entityPermission) {
        PackageTypePK pk = getPackageTypePK();
        PackageType entity = pk == null? null: PackageTypeFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public PackageType getPackageType() {
        return getPackageType(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public PackageType getPackageTypeForUpdate() {
        return getPackageType(EntityPermission.READ_WRITE);
    }
    
    public void setPackageTypePK(@Nullable PackageTypePK packageTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPackageTypePK(packageTypePK);
    }
    
    public void setPackageType(@Nullable PackageType entity) {
        setPackageTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPackageTypePKHasBeenModified() {
        return _value.getPackageTypePKHasBeenModified();
    }
    
    @Nullable
    public UnitOfMeasureTypePK getUnitOfMeasureTypePK() {
        return _value.getUnitOfMeasureTypePK();
    }
    
    @Nullable
    public UnitOfMeasureType getUnitOfMeasureType(EntityPermission entityPermission) {
        UnitOfMeasureTypePK pk = getUnitOfMeasureTypePK();
        UnitOfMeasureType entity = pk == null? null: UnitOfMeasureTypeFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public UnitOfMeasureType getUnitOfMeasureType() {
        return getUnitOfMeasureType(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public UnitOfMeasureType getUnitOfMeasureTypeForUpdate() {
        return getUnitOfMeasureType(EntityPermission.READ_WRITE);
    }
    
    public void setUnitOfMeasureTypePK(@Nullable UnitOfMeasureTypePK unitOfMeasureTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUnitOfMeasureTypePK(unitOfMeasureTypePK);
    }
    
    public void setUnitOfMeasureType(@Nullable UnitOfMeasureType entity) {
        setUnitOfMeasureTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getUnitOfMeasureTypePKHasBeenModified() {
        return _value.getUnitOfMeasureTypePKHasBeenModified();
    }
    
    @Nullable
    public Long getWeight() {
        return _value.getWeight();
    }
    
    public void setWeight(@Nullable Long weight)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setWeight(weight);
    }
    
    public boolean getWeightHasBeenModified() {
        return _value.getWeightHasBeenModified();
    }
    
    @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();
    }
    
}