// --------------------------------------------------------------------------------
// Copyright 2002-2024 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
// --------------------------------------------------------------------------------

/**
 * ShipmentPackageDetailValue.java
 */

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

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

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

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.util.common.exception.PersistenceCloneException;
import com.echothree.util.common.exception.PersistenceNotNullException;

import com.echothree.util.server.persistence.BaseValue;

import java.io.Serializable;

public class ShipmentPackageDetailValue
        extends BaseValue<ShipmentPackageDetailPK>
        implements Cloneable, Serializable {
    
    private ShipmentPackagePK shipmentPackagePK;
    private boolean shipmentPackagePKHasBeenModified = false;
    private ShipmentTypePK shipmentTypePK;
    private boolean shipmentTypePKHasBeenModified = false;
    private String shipmentPackageName;
    private boolean shipmentPackageNameHasBeenModified = false;
    private ShipmentPackagePK parentShipmentPackagePK;
    private boolean parentShipmentPackagePKHasBeenModified = false;
    private ShipmentPK shipmentPK;
    private boolean shipmentPKHasBeenModified = false;
    private PackageTypePK packageTypePK;
    private boolean packageTypePKHasBeenModified = false;
    private UnitOfMeasureTypePK unitOfMeasureTypePK;
    private boolean unitOfMeasureTypePKHasBeenModified = false;
    private Long weight;
    private boolean weightHasBeenModified = false;
    private Long fromTime;
    private boolean fromTimeHasBeenModified = false;
    private Long thruTime;
    private boolean thruTimeHasBeenModified = false;
    
    private transient Integer _hashCode = null;
    private transient String _stringValue = null;
    
    private void constructFields(ShipmentPackagePK shipmentPackagePK, ShipmentTypePK shipmentTypePK, String shipmentPackageName, ShipmentPackagePK parentShipmentPackagePK, ShipmentPK shipmentPK, PackageTypePK packageTypePK, UnitOfMeasureTypePK unitOfMeasureTypePK, Long weight, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        checkForNull(shipmentPackagePK);
        this.shipmentPackagePK = shipmentPackagePK;
        checkForNull(shipmentTypePK);
        this.shipmentTypePK = shipmentTypePK;
        checkForNull(shipmentPackageName);
        this.shipmentPackageName = shipmentPackageName;
        this.parentShipmentPackagePK = parentShipmentPackagePK;
        this.shipmentPK = shipmentPK;
        this.packageTypePK = packageTypePK;
        this.unitOfMeasureTypePK = unitOfMeasureTypePK;
        this.weight = weight;
        checkForNull(fromTime);
        this.fromTime = fromTime;
        checkForNull(thruTime);
        this.thruTime = thruTime;
    }
    
    /** Creates a new instance of ShipmentPackageDetailValue */
    public ShipmentPackageDetailValue(ShipmentPackageDetailPK shipmentPackageDetailPK, ShipmentPackagePK shipmentPackagePK, ShipmentTypePK shipmentTypePK, String shipmentPackageName, ShipmentPackagePK parentShipmentPackagePK, ShipmentPK shipmentPK, PackageTypePK packageTypePK, UnitOfMeasureTypePK unitOfMeasureTypePK, Long weight, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super(shipmentPackageDetailPK);
        constructFields(shipmentPackagePK, shipmentTypePK, shipmentPackageName, parentShipmentPackagePK, shipmentPK, packageTypePK, unitOfMeasureTypePK, weight, fromTime, thruTime);
    }
    
    /** Creates a new instance of ShipmentPackageDetailValue */
    public ShipmentPackageDetailValue(ShipmentPackagePK shipmentPackagePK, ShipmentTypePK shipmentTypePK, String shipmentPackageName, ShipmentPackagePK parentShipmentPackagePK, ShipmentPK shipmentPK, PackageTypePK packageTypePK, UnitOfMeasureTypePK unitOfMeasureTypePK, Long weight, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super();
        constructFields(shipmentPackagePK, shipmentTypePK, shipmentPackageName, parentShipmentPackagePK, shipmentPK, packageTypePK, unitOfMeasureTypePK, weight, fromTime, thruTime);
    }
    
   @Override
   public ShipmentPackageDetailFactory getBaseFactoryInstance() {
        return ShipmentPackageDetailFactory.getInstance();
    }
    
    @Override
    public ShipmentPackageDetailValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (ShipmentPackageDetailValue)result;
    }
    
   @Override
    public ShipmentPackageDetailPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new ShipmentPackageDetailPK(entityId);
        }
        
        return _primaryKey;
    }
    
    private void clearHashAndString() {
        _hashCode = null;
        _stringValue = null;
    }
    
    @Override
    public int hashCode() {
        if(_hashCode == null) {
            int hashCode = 17;
            
            hashCode = 37 * hashCode + ((entityId != null) ? entityId.hashCode() : 0);
            
            hashCode = 37 * hashCode + ((shipmentPackagePK != null) ? shipmentPackagePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((shipmentTypePK != null) ? shipmentTypePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((shipmentPackageName != null) ? shipmentPackageName.hashCode() : 0);
            hashCode = 37 * hashCode + ((parentShipmentPackagePK != null) ? parentShipmentPackagePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((shipmentPK != null) ? shipmentPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((packageTypePK != null) ? packageTypePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((unitOfMeasureTypePK != null) ? unitOfMeasureTypePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((weight != null) ? weight.hashCode() : 0);
            hashCode = 37 * hashCode + ((fromTime != null) ? fromTime.hashCode() : 0);
            hashCode = 37 * hashCode + ((thruTime != null) ? thruTime.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    public String toString() {
        if(_stringValue == null) {
            StringBuilder stringValue = new StringBuilder("{");
            
            stringValue.append("entityId=").append(getEntityId());
            
            stringValue.append(", shipmentPackagePK=").append(getShipmentPackagePK());
            stringValue.append(", shipmentTypePK=").append(getShipmentTypePK());
            stringValue.append(", shipmentPackageName=").append(getShipmentPackageName());
            stringValue.append(", parentShipmentPackagePK=").append(getParentShipmentPackagePK());
            stringValue.append(", shipmentPK=").append(getShipmentPK());
            stringValue.append(", packageTypePK=").append(getPackageTypePK());
            stringValue.append(", unitOfMeasureTypePK=").append(getUnitOfMeasureTypePK());
            stringValue.append(", weight=").append(getWeight());
            stringValue.append(", fromTime=").append(getFromTime());
            stringValue.append(", thruTime=").append(getThruTime());
            
            stringValue.append('}');
            
            _stringValue = stringValue.toString();
        }
        return _stringValue;
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(!hasIdentity())
            return false;
        
        if(other instanceof  ShipmentPackageDetailValue) {
            ShipmentPackageDetailValue that = (ShipmentPackageDetailValue)other;
            
            if(!that.hasIdentity())
                return false;
            
            Long thisEntityId = getEntityId();
            Long thatEntityId = that.getEntityId();
            
            boolean objectsEqual = thisEntityId.equals(thatEntityId);
            if(objectsEqual)
                objectsEqual = objectsEqual && isIdentical(that);
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    public boolean isIdentical(Object other) {
        if(other instanceof ShipmentPackageDetailValue) {
            ShipmentPackageDetailValue that = (ShipmentPackageDetailValue)other;
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                ShipmentPackagePK thisShipmentPackagePK = getShipmentPackagePK();
                ShipmentPackagePK thatShipmentPackagePK = that.getShipmentPackagePK();
                
                if(thisShipmentPackagePK == null) {
                    objectsEqual = objectsEqual && (thatShipmentPackagePK == null);
                } else {
                    objectsEqual = objectsEqual && thisShipmentPackagePK.equals(thatShipmentPackagePK);
                }
            }
            
            if(objectsEqual) {
                ShipmentTypePK thisShipmentTypePK = getShipmentTypePK();
                ShipmentTypePK thatShipmentTypePK = that.getShipmentTypePK();
                
                if(thisShipmentTypePK == null) {
                    objectsEqual = objectsEqual && (thatShipmentTypePK == null);
                } else {
                    objectsEqual = objectsEqual && thisShipmentTypePK.equals(thatShipmentTypePK);
                }
            }
            
            if(objectsEqual) {
                String thisShipmentPackageName = getShipmentPackageName();
                String thatShipmentPackageName = that.getShipmentPackageName();
                
                if(thisShipmentPackageName == null) {
                    objectsEqual = objectsEqual && (thatShipmentPackageName == null);
                } else {
                    objectsEqual = objectsEqual && thisShipmentPackageName.equals(thatShipmentPackageName);
                }
            }
            
            if(objectsEqual) {
                ShipmentPackagePK thisParentShipmentPackagePK = getParentShipmentPackagePK();
                ShipmentPackagePK thatParentShipmentPackagePK = that.getParentShipmentPackagePK();
                
                if(thisParentShipmentPackagePK == null) {
                    objectsEqual = objectsEqual && (thatParentShipmentPackagePK == null);
                } else {
                    objectsEqual = objectsEqual && thisParentShipmentPackagePK.equals(thatParentShipmentPackagePK);
                }
            }
            
            if(objectsEqual) {
                ShipmentPK thisShipmentPK = getShipmentPK();
                ShipmentPK thatShipmentPK = that.getShipmentPK();
                
                if(thisShipmentPK == null) {
                    objectsEqual = objectsEqual && (thatShipmentPK == null);
                } else {
                    objectsEqual = objectsEqual && thisShipmentPK.equals(thatShipmentPK);
                }
            }
            
            if(objectsEqual) {
                PackageTypePK thisPackageTypePK = getPackageTypePK();
                PackageTypePK thatPackageTypePK = that.getPackageTypePK();
                
                if(thisPackageTypePK == null) {
                    objectsEqual = objectsEqual && (thatPackageTypePK == null);
                } else {
                    objectsEqual = objectsEqual && thisPackageTypePK.equals(thatPackageTypePK);
                }
            }
            
            if(objectsEqual) {
                UnitOfMeasureTypePK thisUnitOfMeasureTypePK = getUnitOfMeasureTypePK();
                UnitOfMeasureTypePK thatUnitOfMeasureTypePK = that.getUnitOfMeasureTypePK();
                
                if(thisUnitOfMeasureTypePK == null) {
                    objectsEqual = objectsEqual && (thatUnitOfMeasureTypePK == null);
                } else {
                    objectsEqual = objectsEqual && thisUnitOfMeasureTypePK.equals(thatUnitOfMeasureTypePK);
                }
            }
            
            if(objectsEqual) {
                Long thisWeight = getWeight();
                Long thatWeight = that.getWeight();
                
                if(thisWeight == null) {
                    objectsEqual = objectsEqual && (thatWeight == null);
                } else {
                    objectsEqual = objectsEqual && thisWeight.equals(thatWeight);
                }
            }
            
            if(objectsEqual) {
                Long thisFromTime = getFromTime();
                Long thatFromTime = that.getFromTime();
                
                if(thisFromTime == null) {
                    objectsEqual = objectsEqual && (thatFromTime == null);
                } else {
                    objectsEqual = objectsEqual && thisFromTime.equals(thatFromTime);
                }
            }
            
            if(objectsEqual) {
                Long thisThruTime = getThruTime();
                Long thatThruTime = that.getThruTime();
                
                if(thisThruTime == null) {
                    objectsEqual = objectsEqual && (thatThruTime == null);
                } else {
                    objectsEqual = objectsEqual && thisThruTime.equals(thatThruTime);
                }
            }
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    @Override
    public boolean hasBeenModified() {
        return shipmentPackagePKHasBeenModified || shipmentTypePKHasBeenModified || shipmentPackageNameHasBeenModified || parentShipmentPackagePKHasBeenModified || shipmentPKHasBeenModified || packageTypePKHasBeenModified || unitOfMeasureTypePKHasBeenModified || weightHasBeenModified || fromTimeHasBeenModified || thruTimeHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        shipmentPackagePKHasBeenModified = false;
        shipmentTypePKHasBeenModified = false;
        shipmentPackageNameHasBeenModified = false;
        parentShipmentPackagePKHasBeenModified = false;
        shipmentPKHasBeenModified = false;
        packageTypePKHasBeenModified = false;
        unitOfMeasureTypePKHasBeenModified = false;
        weightHasBeenModified = false;
        fromTimeHasBeenModified = false;
        thruTimeHasBeenModified = false;
    }
    
    public ShipmentPackagePK getShipmentPackagePK() {
        return shipmentPackagePK;
    }
    
    public void setShipmentPackagePK(ShipmentPackagePK shipmentPackagePK)
            throws PersistenceNotNullException {
        checkForNull(shipmentPackagePK);
        
        boolean update = true;
        
        if(this.shipmentPackagePK != null) {
            if(this.shipmentPackagePK.equals(shipmentPackagePK)) {
                update = false;
            }
        } else if(shipmentPackagePK == null) {
            update = false;
        }
        
        if(update) {
            this.shipmentPackagePK = shipmentPackagePK;
            shipmentPackagePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getShipmentPackagePKHasBeenModified() {
        return shipmentPackagePKHasBeenModified;
    }
    
    public ShipmentTypePK getShipmentTypePK() {
        return shipmentTypePK;
    }
    
    public void setShipmentTypePK(ShipmentTypePK shipmentTypePK)
            throws PersistenceNotNullException {
        checkForNull(shipmentTypePK);
        
        boolean update = true;
        
        if(this.shipmentTypePK != null) {
            if(this.shipmentTypePK.equals(shipmentTypePK)) {
                update = false;
            }
        } else if(shipmentTypePK == null) {
            update = false;
        }
        
        if(update) {
            this.shipmentTypePK = shipmentTypePK;
            shipmentTypePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getShipmentTypePKHasBeenModified() {
        return shipmentTypePKHasBeenModified;
    }
    
    public String getShipmentPackageName() {
        return shipmentPackageName;
    }
    
    public void setShipmentPackageName(String shipmentPackageName)
            throws PersistenceNotNullException {
        checkForNull(shipmentPackageName);
        
        boolean update = true;
        
        if(this.shipmentPackageName != null) {
            if(this.shipmentPackageName.equals(shipmentPackageName)) {
                update = false;
            }
        } else if(shipmentPackageName == null) {
            update = false;
        }
        
        if(update) {
            this.shipmentPackageName = shipmentPackageName;
            shipmentPackageNameHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getShipmentPackageNameHasBeenModified() {
        return shipmentPackageNameHasBeenModified;
    }
    
    public ShipmentPackagePK getParentShipmentPackagePK() {
        return parentShipmentPackagePK;
    }
    
    public void setParentShipmentPackagePK(ShipmentPackagePK parentShipmentPackagePK) {
        boolean update = true;
        
        if(this.parentShipmentPackagePK != null) {
            if(this.parentShipmentPackagePK.equals(parentShipmentPackagePK)) {
                update = false;
            }
        } else if(parentShipmentPackagePK == null) {
            update = false;
        }
        
        if(update) {
            this.parentShipmentPackagePK = parentShipmentPackagePK;
            parentShipmentPackagePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getParentShipmentPackagePKHasBeenModified() {
        return parentShipmentPackagePKHasBeenModified;
    }
    
    public ShipmentPK getShipmentPK() {
        return shipmentPK;
    }
    
    public void setShipmentPK(ShipmentPK shipmentPK) {
        boolean update = true;
        
        if(this.shipmentPK != null) {
            if(this.shipmentPK.equals(shipmentPK)) {
                update = false;
            }
        } else if(shipmentPK == null) {
            update = false;
        }
        
        if(update) {
            this.shipmentPK = shipmentPK;
            shipmentPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getShipmentPKHasBeenModified() {
        return shipmentPKHasBeenModified;
    }
    
    public PackageTypePK getPackageTypePK() {
        return packageTypePK;
    }
    
    public void setPackageTypePK(PackageTypePK packageTypePK) {
        boolean update = true;
        
        if(this.packageTypePK != null) {
            if(this.packageTypePK.equals(packageTypePK)) {
                update = false;
            }
        } else if(packageTypePK == null) {
            update = false;
        }
        
        if(update) {
            this.packageTypePK = packageTypePK;
            packageTypePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getPackageTypePKHasBeenModified() {
        return packageTypePKHasBeenModified;
    }
    
    public UnitOfMeasureTypePK getUnitOfMeasureTypePK() {
        return unitOfMeasureTypePK;
    }
    
    public void setUnitOfMeasureTypePK(UnitOfMeasureTypePK unitOfMeasureTypePK) {
        boolean update = true;
        
        if(this.unitOfMeasureTypePK != null) {
            if(this.unitOfMeasureTypePK.equals(unitOfMeasureTypePK)) {
                update = false;
            }
        } else if(unitOfMeasureTypePK == null) {
            update = false;
        }
        
        if(update) {
            this.unitOfMeasureTypePK = unitOfMeasureTypePK;
            unitOfMeasureTypePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getUnitOfMeasureTypePKHasBeenModified() {
        return unitOfMeasureTypePKHasBeenModified;
    }
    
    public Long getWeight() {
        return weight;
    }
    
    public void setWeight(Long weight) {
        boolean update = true;
        
        if(this.weight != null) {
            if(this.weight.equals(weight)) {
                update = false;
            }
        } else if(weight == null) {
            update = false;
        }
        
        if(update) {
            this.weight = weight;
            weightHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getWeightHasBeenModified() {
        return weightHasBeenModified;
    }
    
    public Long getFromTime() {
        return fromTime;
    }
    
    public void setFromTime(Long fromTime)
            throws PersistenceNotNullException {
        checkForNull(fromTime);
        
        boolean update = true;
        
        if(this.fromTime != null) {
            if(this.fromTime.equals(fromTime)) {
                update = false;
            }
        } else if(fromTime == null) {
            update = false;
        }
        
        if(update) {
            this.fromTime = fromTime;
            fromTimeHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getFromTimeHasBeenModified() {
        return fromTimeHasBeenModified;
    }
    
    public Long getThruTime() {
        return thruTime;
    }
    
    public void setThruTime(Long thruTime)
            throws PersistenceNotNullException {
        checkForNull(thruTime);
        
        boolean update = true;
        
        if(this.thruTime != null) {
            if(this.thruTime.equals(thruTime)) {
                update = false;
            }
        } else if(thruTime == null) {
            update = false;
        }
        
        if(update) {
            this.thruTime = thruTime;
            thruTimeHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getThruTimeHasBeenModified() {
        return thruTimeHasBeenModified;
    }
    
}