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

/**
 * SalesOrderValue.java
 */

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

import com.echothree.model.data.sales.common.pk.SalesOrderPK;

import com.echothree.model.data.sales.server.factory.SalesOrderFactory;

import com.echothree.model.data.order.common.pk.OrderPK;
import com.echothree.model.data.offer.common.pk.OfferUsePK;
import com.echothree.model.data.associate.common.pk.AssociateReferralPK;

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 SalesOrderValue
        extends BaseValue<SalesOrderPK>
        implements Cloneable, Serializable {
    
    private OrderPK orderPK;
    private boolean orderPKHasBeenModified = false;
    private OfferUsePK offerUsePK;
    private boolean offerUsePKHasBeenModified = false;
    private AssociateReferralPK associateReferralPK;
    private boolean associateReferralPKHasBeenModified = 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(OrderPK orderPK, OfferUsePK offerUsePK, AssociateReferralPK associateReferralPK, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        checkForNull(orderPK);
        this.orderPK = orderPK;
        checkForNull(offerUsePK);
        this.offerUsePK = offerUsePK;
        this.associateReferralPK = associateReferralPK;
        checkForNull(fromTime);
        this.fromTime = fromTime;
        checkForNull(thruTime);
        this.thruTime = thruTime;
    }
    
    /** Creates a new instance of SalesOrderValue */
    public SalesOrderValue(SalesOrderPK salesOrderPK, OrderPK orderPK, OfferUsePK offerUsePK, AssociateReferralPK associateReferralPK, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super(salesOrderPK);
        constructFields(orderPK, offerUsePK, associateReferralPK, fromTime, thruTime);
    }
    
    /** Creates a new instance of SalesOrderValue */
    public SalesOrderValue(OrderPK orderPK, OfferUsePK offerUsePK, AssociateReferralPK associateReferralPK, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super();
        constructFields(orderPK, offerUsePK, associateReferralPK, fromTime, thruTime);
    }
    
    @Override
    @Nonnull
    public SalesOrderFactory getBaseFactoryInstance() {
        return SalesOrderFactory.getInstance();
    }
    
    @Override
    @Nonnull
    public SalesOrderValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (SalesOrderValue)result;
    }
    
    @Override
    @Nonnull
    public SalesOrderPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new SalesOrderPK(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 + ((offerUsePK != null) ? offerUsePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((associateReferralPK != null) ? associateReferralPK.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() +
                    ", orderPK=" + getOrderPK() +
                    ", offerUsePK=" + getOfferUsePK() +
                    ", associateReferralPK=" + getAssociateReferralPK() +
                    ", fromTime=" + getFromTime() +
                    ", thruTime=" + getThruTime() +
                    "}";
        }
        return _stringValue;
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(!hasIdentity())
            return false;
        
        if(other instanceof  SalesOrderValue 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 SalesOrderValue 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) {
                OfferUsePK thisOfferUsePK = getOfferUsePK();
                OfferUsePK thatOfferUsePK = that.getOfferUsePK();
                
                if(thisOfferUsePK == null) {
                    objectsEqual = objectsEqual && (thatOfferUsePK == null);
                } else {
                    objectsEqual = objectsEqual && thisOfferUsePK.equals(thatOfferUsePK);
                }
            }
            
            if(objectsEqual) {
                AssociateReferralPK thisAssociateReferralPK = getAssociateReferralPK();
                AssociateReferralPK thatAssociateReferralPK = that.getAssociateReferralPK();
                
                if(thisAssociateReferralPK == null) {
                    objectsEqual = objectsEqual && (thatAssociateReferralPK == null);
                } else {
                    objectsEqual = objectsEqual && thisAssociateReferralPK.equals(thatAssociateReferralPK);
                }
            }
            
            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 orderPKHasBeenModified || offerUsePKHasBeenModified || associateReferralPKHasBeenModified || fromTimeHasBeenModified || thruTimeHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        orderPKHasBeenModified = false;
        offerUsePKHasBeenModified = false;
        associateReferralPKHasBeenModified = false;
        fromTimeHasBeenModified = false;
        thruTimeHasBeenModified = 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 OfferUsePK getOfferUsePK() {
        return offerUsePK;
    }
    
    public void setOfferUsePK(@Nonnull OfferUsePK offerUsePK)
            throws PersistenceNotNullException {
        checkForNull(offerUsePK);
        
        boolean update = true;
        
        if(this.offerUsePK != null) {
            if(this.offerUsePK.equals(offerUsePK)) {
                update = false;
            }
        } else if(offerUsePK == null) {
            update = false;
        }
        
        if(update) {
            this.offerUsePK = offerUsePK;
            offerUsePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getOfferUsePKHasBeenModified() {
        return offerUsePKHasBeenModified;
    }
    
    @Nullable
    public AssociateReferralPK getAssociateReferralPK() {
        return associateReferralPK;
    }
    
    public void setAssociateReferralPK(@Nullable AssociateReferralPK associateReferralPK) {
        boolean update = true;
        
        if(this.associateReferralPK != null) {
            if(this.associateReferralPK.equals(associateReferralPK)) {
                update = false;
            }
        } else if(associateReferralPK == null) {
            update = false;
        }
        
        if(update) {
            this.associateReferralPK = associateReferralPK;
            associateReferralPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getAssociateReferralPKHasBeenModified() {
        return associateReferralPKHasBeenModified;
    }
    
    @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;
    }
    
}