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

/**
 * InventoryLocationGroupVolumeValue.java
 */

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

import com.echothree.model.data.inventory.common.pk.InventoryLocationGroupVolumePK;

import com.echothree.model.data.inventory.server.factory.InventoryLocationGroupVolumeFactory;

import com.echothree.model.data.inventory.common.pk.InventoryLocationGroupPK;

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;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

public class InventoryLocationGroupVolumeValue
        extends BaseValue<InventoryLocationGroupVolumePK>
        implements Cloneable, Serializable {
    
    private InventoryLocationGroupPK inventoryLocationGroupPK;
    private boolean inventoryLocationGroupPKHasBeenModified = false;
    private Long height;
    private boolean heightHasBeenModified = false;
    private Long width;
    private boolean widthHasBeenModified = false;
    private Long depth;
    private boolean depthHasBeenModified = 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(InventoryLocationGroupPK inventoryLocationGroupPK, Long height, Long width, Long depth, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        checkForNull(inventoryLocationGroupPK);
        this.inventoryLocationGroupPK = inventoryLocationGroupPK;
        checkForNull(height);
        this.height = height;
        checkForNull(width);
        this.width = width;
        checkForNull(depth);
        this.depth = depth;
        checkForNull(fromTime);
        this.fromTime = fromTime;
        checkForNull(thruTime);
        this.thruTime = thruTime;
    }
    
    /** Creates a new instance of InventoryLocationGroupVolumeValue */
    public InventoryLocationGroupVolumeValue(InventoryLocationGroupVolumePK inventoryLocationGroupVolumePK, InventoryLocationGroupPK inventoryLocationGroupPK, Long height, Long width, Long depth, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super(inventoryLocationGroupVolumePK);
        constructFields(inventoryLocationGroupPK, height, width, depth, fromTime, thruTime);
    }
    
    /** Creates a new instance of InventoryLocationGroupVolumeValue */
    public InventoryLocationGroupVolumeValue(InventoryLocationGroupPK inventoryLocationGroupPK, Long height, Long width, Long depth, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super();
        constructFields(inventoryLocationGroupPK, height, width, depth, fromTime, thruTime);
    }
    
    @Override
    @Nonnull
    public InventoryLocationGroupVolumeFactory getBaseFactoryInstance() {
        return InventoryLocationGroupVolumeFactory.getInstance();
    }
    
    @Override
    @Nonnull
    public InventoryLocationGroupVolumeValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (InventoryLocationGroupVolumeValue)result;
    }
    
    @Override
    @Nonnull
    public InventoryLocationGroupVolumePK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new InventoryLocationGroupVolumePK(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 + ((inventoryLocationGroupPK != null) ? inventoryLocationGroupPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((height != null) ? height.hashCode() : 0);
            hashCode = 37 * hashCode + ((width != null) ? width.hashCode() : 0);
            hashCode = 37 * hashCode + ((depth != null) ? depth.hashCode() : 0);
            hashCode = 37 * hashCode + ((fromTime != null) ? fromTime.hashCode() : 0);
            hashCode = 37 * hashCode + ((thruTime != null) ? thruTime.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    @Nonnull
    public String toString() {
        if(_stringValue == null) {
            _stringValue = "{" + 
                    "entityId=" + getEntityId() +
                    ", inventoryLocationGroupPK=" + getInventoryLocationGroupPK() +
                    ", height=" + getHeight() +
                    ", width=" + getWidth() +
                    ", depth=" + getDepth() +
                    ", fromTime=" + getFromTime() +
                    ", thruTime=" + getThruTime() +
                    "}";
        }
        return _stringValue;
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(!hasIdentity())
            return false;
        
        if(other instanceof  InventoryLocationGroupVolumeValue that) {
            if(!that.hasIdentity())
                return false;
            
            Long thisEntityId = getEntityId();
            Long thatEntityId = that.getEntityId();
            
            boolean objectsEqual = thisEntityId.equals(thatEntityId);
            if(objectsEqual)
                objectsEqual = isIdentical(that);
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    public boolean isIdentical(Object other) {
        if(other instanceof InventoryLocationGroupVolumeValue that) {
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                InventoryLocationGroupPK thisInventoryLocationGroupPK = getInventoryLocationGroupPK();
                InventoryLocationGroupPK thatInventoryLocationGroupPK = that.getInventoryLocationGroupPK();
                
                if(thisInventoryLocationGroupPK == null) {
                    objectsEqual = objectsEqual && (thatInventoryLocationGroupPK == null);
                } else {
                    objectsEqual = objectsEqual && thisInventoryLocationGroupPK.equals(thatInventoryLocationGroupPK);
                }
            }
            
            if(objectsEqual) {
                Long thisHeight = getHeight();
                Long thatHeight = that.getHeight();
                
                if(thisHeight == null) {
                    objectsEqual = objectsEqual && (thatHeight == null);
                } else {
                    objectsEqual = objectsEqual && thisHeight.equals(thatHeight);
                }
            }
            
            if(objectsEqual) {
                Long thisWidth = getWidth();
                Long thatWidth = that.getWidth();
                
                if(thisWidth == null) {
                    objectsEqual = objectsEqual && (thatWidth == null);
                } else {
                    objectsEqual = objectsEqual && thisWidth.equals(thatWidth);
                }
            }
            
            if(objectsEqual) {
                Long thisDepth = getDepth();
                Long thatDepth = that.getDepth();
                
                if(thisDepth == null) {
                    objectsEqual = objectsEqual && (thatDepth == null);
                } else {
                    objectsEqual = objectsEqual && thisDepth.equals(thatDepth);
                }
            }
            
            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 inventoryLocationGroupPKHasBeenModified || heightHasBeenModified || widthHasBeenModified || depthHasBeenModified || fromTimeHasBeenModified || thruTimeHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        inventoryLocationGroupPKHasBeenModified = false;
        heightHasBeenModified = false;
        widthHasBeenModified = false;
        depthHasBeenModified = false;
        fromTimeHasBeenModified = false;
        thruTimeHasBeenModified = false;
    }
    
    @Nonnull
    public InventoryLocationGroupPK getInventoryLocationGroupPK() {
        return inventoryLocationGroupPK;
    }
    
    public void setInventoryLocationGroupPK(@Nonnull InventoryLocationGroupPK inventoryLocationGroupPK)
            throws PersistenceNotNullException {
        checkForNull(inventoryLocationGroupPK);
        
        boolean update = true;
        
        if(this.inventoryLocationGroupPK != null) {
            if(this.inventoryLocationGroupPK.equals(inventoryLocationGroupPK)) {
                update = false;
            }
        } else if(inventoryLocationGroupPK == null) {
            update = false;
        }
        
        if(update) {
            this.inventoryLocationGroupPK = inventoryLocationGroupPK;
            inventoryLocationGroupPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getInventoryLocationGroupPKHasBeenModified() {
        return inventoryLocationGroupPKHasBeenModified;
    }
    
    @Nonnull
    public Long getHeight() {
        return height;
    }
    
    public void setHeight(@Nonnull Long height)
            throws PersistenceNotNullException {
        checkForNull(height);
        
        boolean update = true;
        
        if(this.height != null) {
            if(this.height.equals(height)) {
                update = false;
            }
        } else if(height == null) {
            update = false;
        }
        
        if(update) {
            this.height = height;
            heightHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getHeightHasBeenModified() {
        return heightHasBeenModified;
    }
    
    @Nonnull
    public Long getWidth() {
        return width;
    }
    
    public void setWidth(@Nonnull Long width)
            throws PersistenceNotNullException {
        checkForNull(width);
        
        boolean update = true;
        
        if(this.width != null) {
            if(this.width.equals(width)) {
                update = false;
            }
        } else if(width == null) {
            update = false;
        }
        
        if(update) {
            this.width = width;
            widthHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getWidthHasBeenModified() {
        return widthHasBeenModified;
    }
    
    @Nonnull
    public Long getDepth() {
        return depth;
    }
    
    public void setDepth(@Nonnull Long depth)
            throws PersistenceNotNullException {
        checkForNull(depth);
        
        boolean update = true;
        
        if(this.depth != null) {
            if(this.depth.equals(depth)) {
                update = false;
            }
        } else if(depth == null) {
            update = false;
        }
        
        if(update) {
            this.depth = depth;
            depthHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getDepthHasBeenModified() {
        return depthHasBeenModified;
    }
    
    @Nonnull
    public Long getFromTime() {
        return fromTime;
    }
    
    public void setFromTime(@Nonnull 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;
    }
    
    @Nonnull
    public Long getThruTime() {
        return thruTime;
    }
    
    public void setThruTime(@Nonnull 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;
    }
    
}