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

/**
 * OrderStatusValue.java
 */

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

import com.echothree.model.data.order.common.pk.OrderStatusPK;

import com.echothree.model.data.order.server.factory.OrderStatusFactory;

import com.echothree.model.data.order.common.pk.OrderPK;

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 OrderStatusValue
        extends BaseValue<OrderStatusPK>
        implements Cloneable, Serializable {
    
    private OrderPK orderPK;
    private boolean orderPKHasBeenModified = false;
    private Integer orderShipmentGroupSequence;
    private boolean orderShipmentGroupSequenceHasBeenModified = false;
    private Integer orderLineSequence;
    private boolean orderLineSequenceHasBeenModified = false;
    private Integer orderAdjustmentSequence;
    private boolean orderAdjustmentSequenceHasBeenModified = false;
    private Integer orderPaymentPreferenceSequence;
    private boolean orderPaymentPreferenceSequenceHasBeenModified = false;
    
    private transient Integer _hashCode = null;
    private transient String _stringValue = null;
    
    private void constructFields(OrderPK orderPK, Integer orderShipmentGroupSequence, Integer orderLineSequence, Integer orderAdjustmentSequence, Integer orderPaymentPreferenceSequence)
            throws PersistenceNotNullException {
        checkForNull(orderPK);
        this.orderPK = orderPK;
        checkForNull(orderShipmentGroupSequence);
        this.orderShipmentGroupSequence = orderShipmentGroupSequence;
        checkForNull(orderLineSequence);
        this.orderLineSequence = orderLineSequence;
        checkForNull(orderAdjustmentSequence);
        this.orderAdjustmentSequence = orderAdjustmentSequence;
        checkForNull(orderPaymentPreferenceSequence);
        this.orderPaymentPreferenceSequence = orderPaymentPreferenceSequence;
    }
    
    /** Creates a new instance of OrderStatusValue */
    public OrderStatusValue(OrderStatusPK orderStatusPK, OrderPK orderPK, Integer orderShipmentGroupSequence, Integer orderLineSequence, Integer orderAdjustmentSequence, Integer orderPaymentPreferenceSequence)
            throws PersistenceNotNullException {
        super(orderStatusPK);
        constructFields(orderPK, orderShipmentGroupSequence, orderLineSequence, orderAdjustmentSequence, orderPaymentPreferenceSequence);
    }
    
    /** Creates a new instance of OrderStatusValue */
    public OrderStatusValue(OrderPK orderPK, Integer orderShipmentGroupSequence, Integer orderLineSequence, Integer orderAdjustmentSequence, Integer orderPaymentPreferenceSequence)
            throws PersistenceNotNullException {
        super();
        constructFields(orderPK, orderShipmentGroupSequence, orderLineSequence, orderAdjustmentSequence, orderPaymentPreferenceSequence);
    }
    
    @Override
    @Nonnull
    public OrderStatusFactory getBaseFactoryInstance() {
        return OrderStatusFactory.getInstance();
    }
    
    @Override
    @Nonnull
    public OrderStatusValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (OrderStatusValue)result;
    }
    
    @Override
    @Nonnull
    public OrderStatusPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new OrderStatusPK(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 + ((orderPK != null) ? orderPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((orderShipmentGroupSequence != null) ? orderShipmentGroupSequence.hashCode() : 0);
            hashCode = 37 * hashCode + ((orderLineSequence != null) ? orderLineSequence.hashCode() : 0);
            hashCode = 37 * hashCode + ((orderAdjustmentSequence != null) ? orderAdjustmentSequence.hashCode() : 0);
            hashCode = 37 * hashCode + ((orderPaymentPreferenceSequence != null) ? orderPaymentPreferenceSequence.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    @Nonnull
    public String toString() {
        if(_stringValue == null) {
            _stringValue = "{" + 
                    "entityId=" + getEntityId() +
                    ", orderPK=" + getOrderPK() +
                    ", orderShipmentGroupSequence=" + getOrderShipmentGroupSequence() +
                    ", orderLineSequence=" + getOrderLineSequence() +
                    ", orderAdjustmentSequence=" + getOrderAdjustmentSequence() +
                    ", orderPaymentPreferenceSequence=" + getOrderPaymentPreferenceSequence() +
                    "}";
        }
        return _stringValue;
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(!hasIdentity())
            return false;
        
        if(other instanceof  OrderStatusValue 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 OrderStatusValue that) {
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                OrderPK thisOrderPK = getOrderPK();
                OrderPK thatOrderPK = that.getOrderPK();
                
                if(thisOrderPK == null) {
                    objectsEqual = objectsEqual && (thatOrderPK == null);
                } else {
                    objectsEqual = objectsEqual && thisOrderPK.equals(thatOrderPK);
                }
            }
            
            if(objectsEqual) {
                Integer thisOrderShipmentGroupSequence = getOrderShipmentGroupSequence();
                Integer thatOrderShipmentGroupSequence = that.getOrderShipmentGroupSequence();
                
                if(thisOrderShipmentGroupSequence == null) {
                    objectsEqual = objectsEqual && (thatOrderShipmentGroupSequence == null);
                } else {
                    objectsEqual = objectsEqual && thisOrderShipmentGroupSequence.equals(thatOrderShipmentGroupSequence);
                }
            }
            
            if(objectsEqual) {
                Integer thisOrderLineSequence = getOrderLineSequence();
                Integer thatOrderLineSequence = that.getOrderLineSequence();
                
                if(thisOrderLineSequence == null) {
                    objectsEqual = objectsEqual && (thatOrderLineSequence == null);
                } else {
                    objectsEqual = objectsEqual && thisOrderLineSequence.equals(thatOrderLineSequence);
                }
            }
            
            if(objectsEqual) {
                Integer thisOrderAdjustmentSequence = getOrderAdjustmentSequence();
                Integer thatOrderAdjustmentSequence = that.getOrderAdjustmentSequence();
                
                if(thisOrderAdjustmentSequence == null) {
                    objectsEqual = objectsEqual && (thatOrderAdjustmentSequence == null);
                } else {
                    objectsEqual = objectsEqual && thisOrderAdjustmentSequence.equals(thatOrderAdjustmentSequence);
                }
            }
            
            if(objectsEqual) {
                Integer thisOrderPaymentPreferenceSequence = getOrderPaymentPreferenceSequence();
                Integer thatOrderPaymentPreferenceSequence = that.getOrderPaymentPreferenceSequence();
                
                if(thisOrderPaymentPreferenceSequence == null) {
                    objectsEqual = objectsEqual && (thatOrderPaymentPreferenceSequence == null);
                } else {
                    objectsEqual = objectsEqual && thisOrderPaymentPreferenceSequence.equals(thatOrderPaymentPreferenceSequence);
                }
            }
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    @Override
    public boolean hasBeenModified() {
        return orderPKHasBeenModified || orderShipmentGroupSequenceHasBeenModified || orderLineSequenceHasBeenModified || orderAdjustmentSequenceHasBeenModified || orderPaymentPreferenceSequenceHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        orderPKHasBeenModified = false;
        orderShipmentGroupSequenceHasBeenModified = false;
        orderLineSequenceHasBeenModified = false;
        orderAdjustmentSequenceHasBeenModified = false;
        orderPaymentPreferenceSequenceHasBeenModified = false;
    }
    
    @Nonnull
    public OrderPK getOrderPK() {
        return orderPK;
    }
    
    public void setOrderPK(@Nonnull OrderPK orderPK)
            throws PersistenceNotNullException {
        checkForNull(orderPK);
        
        boolean update = true;
        
        if(this.orderPK != null) {
            if(this.orderPK.equals(orderPK)) {
                update = false;
            }
        } else if(orderPK == null) {
            update = false;
        }
        
        if(update) {
            this.orderPK = orderPK;
            orderPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getOrderPKHasBeenModified() {
        return orderPKHasBeenModified;
    }
    
    @Nonnull
    public Integer getOrderShipmentGroupSequence() {
        return orderShipmentGroupSequence;
    }
    
    public void setOrderShipmentGroupSequence(@Nonnull Integer orderShipmentGroupSequence)
            throws PersistenceNotNullException {
        checkForNull(orderShipmentGroupSequence);
        
        boolean update = true;
        
        if(this.orderShipmentGroupSequence != null) {
            if(this.orderShipmentGroupSequence.equals(orderShipmentGroupSequence)) {
                update = false;
            }
        } else if(orderShipmentGroupSequence == null) {
            update = false;
        }
        
        if(update) {
            this.orderShipmentGroupSequence = orderShipmentGroupSequence;
            orderShipmentGroupSequenceHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getOrderShipmentGroupSequenceHasBeenModified() {
        return orderShipmentGroupSequenceHasBeenModified;
    }
    
    @Nonnull
    public Integer getOrderLineSequence() {
        return orderLineSequence;
    }
    
    public void setOrderLineSequence(@Nonnull Integer orderLineSequence)
            throws PersistenceNotNullException {
        checkForNull(orderLineSequence);
        
        boolean update = true;
        
        if(this.orderLineSequence != null) {
            if(this.orderLineSequence.equals(orderLineSequence)) {
                update = false;
            }
        } else if(orderLineSequence == null) {
            update = false;
        }
        
        if(update) {
            this.orderLineSequence = orderLineSequence;
            orderLineSequenceHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getOrderLineSequenceHasBeenModified() {
        return orderLineSequenceHasBeenModified;
    }
    
    @Nonnull
    public Integer getOrderAdjustmentSequence() {
        return orderAdjustmentSequence;
    }
    
    public void setOrderAdjustmentSequence(@Nonnull Integer orderAdjustmentSequence)
            throws PersistenceNotNullException {
        checkForNull(orderAdjustmentSequence);
        
        boolean update = true;
        
        if(this.orderAdjustmentSequence != null) {
            if(this.orderAdjustmentSequence.equals(orderAdjustmentSequence)) {
                update = false;
            }
        } else if(orderAdjustmentSequence == null) {
            update = false;
        }
        
        if(update) {
            this.orderAdjustmentSequence = orderAdjustmentSequence;
            orderAdjustmentSequenceHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getOrderAdjustmentSequenceHasBeenModified() {
        return orderAdjustmentSequenceHasBeenModified;
    }
    
    @Nonnull
    public Integer getOrderPaymentPreferenceSequence() {
        return orderPaymentPreferenceSequence;
    }
    
    public void setOrderPaymentPreferenceSequence(@Nonnull Integer orderPaymentPreferenceSequence)
            throws PersistenceNotNullException {
        checkForNull(orderPaymentPreferenceSequence);
        
        boolean update = true;
        
        if(this.orderPaymentPreferenceSequence != null) {
            if(this.orderPaymentPreferenceSequence.equals(orderPaymentPreferenceSequence)) {
                update = false;
            }
        } else if(orderPaymentPreferenceSequence == null) {
            update = false;
        }
        
        if(update) {
            this.orderPaymentPreferenceSequence = orderPaymentPreferenceSequence;
            orderPaymentPreferenceSequenceHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getOrderPaymentPreferenceSequenceHasBeenModified() {
        return orderPaymentPreferenceSequenceHasBeenModified;
    }
    
}