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

/**
 * LocationDetailValue.java
 */

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

import com.echothree.model.data.warehouse.common.pk.LocationDetailPK;

import com.echothree.model.data.warehouse.server.factory.LocationDetailFactory;

import com.echothree.model.data.warehouse.common.pk.LocationPK;
import com.echothree.model.data.party.common.pk.PartyPK;
import com.echothree.model.data.warehouse.common.pk.LocationTypePK;
import com.echothree.model.data.warehouse.common.pk.LocationUseTypePK;
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;

public class LocationDetailValue
        extends BaseValue<LocationDetailPK>
        implements Cloneable, Serializable {
    
    private LocationPK locationPK;
    private boolean locationPKHasBeenModified = false;
    private PartyPK warehousePartyPK;
    private boolean warehousePartyPKHasBeenModified = false;
    private String locationName;
    private boolean locationNameHasBeenModified = false;
    private LocationTypePK locationTypePK;
    private boolean locationTypePKHasBeenModified = false;
    private LocationUseTypePK locationUseTypePK;
    private boolean locationUseTypePKHasBeenModified = false;
    private Integer velocity;
    private boolean velocityHasBeenModified = false;
    private InventoryLocationGroupPK inventoryLocationGroupPK;
    private boolean inventoryLocationGroupPKHasBeenModified = 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(LocationPK locationPK, PartyPK warehousePartyPK, String locationName, LocationTypePK locationTypePK, LocationUseTypePK locationUseTypePK, Integer velocity, InventoryLocationGroupPK inventoryLocationGroupPK, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        checkForNull(locationPK);
        this.locationPK = locationPK;
        checkForNull(warehousePartyPK);
        this.warehousePartyPK = warehousePartyPK;
        checkForNull(locationName);
        this.locationName = locationName;
        checkForNull(locationTypePK);
        this.locationTypePK = locationTypePK;
        checkForNull(locationUseTypePK);
        this.locationUseTypePK = locationUseTypePK;
        checkForNull(velocity);
        this.velocity = velocity;
        checkForNull(inventoryLocationGroupPK);
        this.inventoryLocationGroupPK = inventoryLocationGroupPK;
        checkForNull(fromTime);
        this.fromTime = fromTime;
        checkForNull(thruTime);
        this.thruTime = thruTime;
    }
    
    /** Creates a new instance of LocationDetailValue */
    public LocationDetailValue(LocationDetailPK locationDetailPK, LocationPK locationPK, PartyPK warehousePartyPK, String locationName, LocationTypePK locationTypePK, LocationUseTypePK locationUseTypePK, Integer velocity, InventoryLocationGroupPK inventoryLocationGroupPK, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super(locationDetailPK);
        constructFields(locationPK, warehousePartyPK, locationName, locationTypePK, locationUseTypePK, velocity, inventoryLocationGroupPK, fromTime, thruTime);
    }
    
    /** Creates a new instance of LocationDetailValue */
    public LocationDetailValue(LocationPK locationPK, PartyPK warehousePartyPK, String locationName, LocationTypePK locationTypePK, LocationUseTypePK locationUseTypePK, Integer velocity, InventoryLocationGroupPK inventoryLocationGroupPK, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super();
        constructFields(locationPK, warehousePartyPK, locationName, locationTypePK, locationUseTypePK, velocity, inventoryLocationGroupPK, fromTime, thruTime);
    }
    
   @Override
   public LocationDetailFactory getBaseFactoryInstance() {
        return LocationDetailFactory.getInstance();
    }
    
    @Override
    public LocationDetailValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (LocationDetailValue)result;
    }
    
   @Override
    public LocationDetailPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new LocationDetailPK(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 + ((locationPK != null) ? locationPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((warehousePartyPK != null) ? warehousePartyPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((locationName != null) ? locationName.hashCode() : 0);
            hashCode = 37 * hashCode + ((locationTypePK != null) ? locationTypePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((locationUseTypePK != null) ? locationUseTypePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((velocity != null) ? velocity.hashCode() : 0);
            hashCode = 37 * hashCode + ((inventoryLocationGroupPK != null) ? inventoryLocationGroupPK.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(", locationPK=").append(getLocationPK());
            stringValue.append(", warehousePartyPK=").append(getWarehousePartyPK());
            stringValue.append(", locationName=").append(getLocationName());
            stringValue.append(", locationTypePK=").append(getLocationTypePK());
            stringValue.append(", locationUseTypePK=").append(getLocationUseTypePK());
            stringValue.append(", velocity=").append(getVelocity());
            stringValue.append(", inventoryLocationGroupPK=").append(getInventoryLocationGroupPK());
            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  LocationDetailValue) {
            LocationDetailValue that = (LocationDetailValue)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 LocationDetailValue) {
            LocationDetailValue that = (LocationDetailValue)other;
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                LocationPK thisLocationPK = getLocationPK();
                LocationPK thatLocationPK = that.getLocationPK();
                
                if(thisLocationPK == null) {
                    objectsEqual = objectsEqual && (thatLocationPK == null);
                } else {
                    objectsEqual = objectsEqual && thisLocationPK.equals(thatLocationPK);
                }
            }
            
            if(objectsEqual) {
                PartyPK thisWarehousePartyPK = getWarehousePartyPK();
                PartyPK thatWarehousePartyPK = that.getWarehousePartyPK();
                
                if(thisWarehousePartyPK == null) {
                    objectsEqual = objectsEqual && (thatWarehousePartyPK == null);
                } else {
                    objectsEqual = objectsEqual && thisWarehousePartyPK.equals(thatWarehousePartyPK);
                }
            }
            
            if(objectsEqual) {
                String thisLocationName = getLocationName();
                String thatLocationName = that.getLocationName();
                
                if(thisLocationName == null) {
                    objectsEqual = objectsEqual && (thatLocationName == null);
                } else {
                    objectsEqual = objectsEqual && thisLocationName.equals(thatLocationName);
                }
            }
            
            if(objectsEqual) {
                LocationTypePK thisLocationTypePK = getLocationTypePK();
                LocationTypePK thatLocationTypePK = that.getLocationTypePK();
                
                if(thisLocationTypePK == null) {
                    objectsEqual = objectsEqual && (thatLocationTypePK == null);
                } else {
                    objectsEqual = objectsEqual && thisLocationTypePK.equals(thatLocationTypePK);
                }
            }
            
            if(objectsEqual) {
                LocationUseTypePK thisLocationUseTypePK = getLocationUseTypePK();
                LocationUseTypePK thatLocationUseTypePK = that.getLocationUseTypePK();
                
                if(thisLocationUseTypePK == null) {
                    objectsEqual = objectsEqual && (thatLocationUseTypePK == null);
                } else {
                    objectsEqual = objectsEqual && thisLocationUseTypePK.equals(thatLocationUseTypePK);
                }
            }
            
            if(objectsEqual) {
                Integer thisVelocity = getVelocity();
                Integer thatVelocity = that.getVelocity();
                
                if(thisVelocity == null) {
                    objectsEqual = objectsEqual && (thatVelocity == null);
                } else {
                    objectsEqual = objectsEqual && thisVelocity.equals(thatVelocity);
                }
            }
            
            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 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 locationPKHasBeenModified || warehousePartyPKHasBeenModified || locationNameHasBeenModified || locationTypePKHasBeenModified || locationUseTypePKHasBeenModified || velocityHasBeenModified || inventoryLocationGroupPKHasBeenModified || fromTimeHasBeenModified || thruTimeHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        locationPKHasBeenModified = false;
        warehousePartyPKHasBeenModified = false;
        locationNameHasBeenModified = false;
        locationTypePKHasBeenModified = false;
        locationUseTypePKHasBeenModified = false;
        velocityHasBeenModified = false;
        inventoryLocationGroupPKHasBeenModified = false;
        fromTimeHasBeenModified = false;
        thruTimeHasBeenModified = false;
    }
    
    public LocationPK getLocationPK() {
        return locationPK;
    }
    
    public void setLocationPK(LocationPK locationPK)
            throws PersistenceNotNullException {
        checkForNull(locationPK);
        
        boolean update = true;
        
        if(this.locationPK != null) {
            if(this.locationPK.equals(locationPK)) {
                update = false;
            }
        } else if(locationPK == null) {
            update = false;
        }
        
        if(update) {
            this.locationPK = locationPK;
            locationPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getLocationPKHasBeenModified() {
        return locationPKHasBeenModified;
    }
    
    public PartyPK getWarehousePartyPK() {
        return warehousePartyPK;
    }
    
    public void setWarehousePartyPK(PartyPK warehousePartyPK)
            throws PersistenceNotNullException {
        checkForNull(warehousePartyPK);
        
        boolean update = true;
        
        if(this.warehousePartyPK != null) {
            if(this.warehousePartyPK.equals(warehousePartyPK)) {
                update = false;
            }
        } else if(warehousePartyPK == null) {
            update = false;
        }
        
        if(update) {
            this.warehousePartyPK = warehousePartyPK;
            warehousePartyPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getWarehousePartyPKHasBeenModified() {
        return warehousePartyPKHasBeenModified;
    }
    
    public String getLocationName() {
        return locationName;
    }
    
    public void setLocationName(String locationName)
            throws PersistenceNotNullException {
        checkForNull(locationName);
        
        boolean update = true;
        
        if(this.locationName != null) {
            if(this.locationName.equals(locationName)) {
                update = false;
            }
        } else if(locationName == null) {
            update = false;
        }
        
        if(update) {
            this.locationName = locationName;
            locationNameHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getLocationNameHasBeenModified() {
        return locationNameHasBeenModified;
    }
    
    public LocationTypePK getLocationTypePK() {
        return locationTypePK;
    }
    
    public void setLocationTypePK(LocationTypePK locationTypePK)
            throws PersistenceNotNullException {
        checkForNull(locationTypePK);
        
        boolean update = true;
        
        if(this.locationTypePK != null) {
            if(this.locationTypePK.equals(locationTypePK)) {
                update = false;
            }
        } else if(locationTypePK == null) {
            update = false;
        }
        
        if(update) {
            this.locationTypePK = locationTypePK;
            locationTypePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getLocationTypePKHasBeenModified() {
        return locationTypePKHasBeenModified;
    }
    
    public LocationUseTypePK getLocationUseTypePK() {
        return locationUseTypePK;
    }
    
    public void setLocationUseTypePK(LocationUseTypePK locationUseTypePK)
            throws PersistenceNotNullException {
        checkForNull(locationUseTypePK);
        
        boolean update = true;
        
        if(this.locationUseTypePK != null) {
            if(this.locationUseTypePK.equals(locationUseTypePK)) {
                update = false;
            }
        } else if(locationUseTypePK == null) {
            update = false;
        }
        
        if(update) {
            this.locationUseTypePK = locationUseTypePK;
            locationUseTypePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getLocationUseTypePKHasBeenModified() {
        return locationUseTypePKHasBeenModified;
    }
    
    public Integer getVelocity() {
        return velocity;
    }
    
    public void setVelocity(Integer velocity)
            throws PersistenceNotNullException {
        checkForNull(velocity);
        
        boolean update = true;
        
        if(this.velocity != null) {
            if(this.velocity.equals(velocity)) {
                update = false;
            }
        } else if(velocity == null) {
            update = false;
        }
        
        if(update) {
            this.velocity = velocity;
            velocityHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getVelocityHasBeenModified() {
        return velocityHasBeenModified;
    }
    
    public InventoryLocationGroupPK getInventoryLocationGroupPK() {
        return inventoryLocationGroupPK;
    }
    
    public void setInventoryLocationGroupPK(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;
    }
    
    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;
    }
    
}