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

/**
 * PaymentCheckValue.java
 */

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

import com.echothree.model.data.payment.common.pk.PaymentCheckPK;

import com.echothree.model.data.payment.server.factory.PaymentCheckFactory;

import com.echothree.model.data.payment.common.pk.PaymentPK;

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 PaymentCheckValue
        extends BaseValue<PaymentCheckPK>
        implements Cloneable, Serializable {
    
    private PaymentPK paymentPK;
    private boolean paymentPKHasBeenModified = false;
    private String reference;
    private boolean referenceHasBeenModified = 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(PaymentPK paymentPK, String reference, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        this.paymentPK = paymentPK;
        checkForNull(reference);
        this.reference = reference;
        checkForNull(fromTime);
        this.fromTime = fromTime;
        checkForNull(thruTime);
        this.thruTime = thruTime;
    }
    
    /** Creates a new instance of PaymentCheckValue */
    public PaymentCheckValue(PaymentCheckPK paymentCheckPK, PaymentPK paymentPK, String reference, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super(paymentCheckPK);
        constructFields(paymentPK, reference, fromTime, thruTime);
    }
    
    /** Creates a new instance of PaymentCheckValue */
    public PaymentCheckValue(PaymentPK paymentPK, String reference, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super();
        constructFields(paymentPK, reference, fromTime, thruTime);
    }
    
   @Override
   public PaymentCheckFactory getBaseFactoryInstance() {
        return PaymentCheckFactory.getInstance();
    }
    
    @Override
    public PaymentCheckValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (PaymentCheckValue)result;
    }
    
   @Override
    public PaymentCheckPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new PaymentCheckPK(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 + ((paymentPK != null) ? paymentPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((reference != null) ? reference.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(", paymentPK=").append(getPaymentPK());
            stringValue.append(", reference=").append(getReference());
            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  PaymentCheckValue) {
            PaymentCheckValue that = (PaymentCheckValue)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 PaymentCheckValue) {
            PaymentCheckValue that = (PaymentCheckValue)other;
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                PaymentPK thisPaymentPK = getPaymentPK();
                PaymentPK thatPaymentPK = that.getPaymentPK();
                
                if(thisPaymentPK == null) {
                    objectsEqual = objectsEqual && (thatPaymentPK == null);
                } else {
                    objectsEqual = objectsEqual && thisPaymentPK.equals(thatPaymentPK);
                }
            }
            
            if(objectsEqual) {
                String thisReference = getReference();
                String thatReference = that.getReference();
                
                if(thisReference == null) {
                    objectsEqual = objectsEqual && (thatReference == null);
                } else {
                    objectsEqual = objectsEqual && thisReference.equals(thatReference);
                }
            }
            
            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 paymentPKHasBeenModified || referenceHasBeenModified || fromTimeHasBeenModified || thruTimeHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        paymentPKHasBeenModified = false;
        referenceHasBeenModified = false;
        fromTimeHasBeenModified = false;
        thruTimeHasBeenModified = false;
    }
    
    public PaymentPK getPaymentPK() {
        return paymentPK;
    }
    
    public void setPaymentPK(PaymentPK paymentPK) {
        boolean update = true;
        
        if(this.paymentPK != null) {
            if(this.paymentPK.equals(paymentPK)) {
                update = false;
            }
        } else if(paymentPK == null) {
            update = false;
        }
        
        if(update) {
            this.paymentPK = paymentPK;
            paymentPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getPaymentPKHasBeenModified() {
        return paymentPKHasBeenModified;
    }
    
    public String getReference() {
        return reference;
    }
    
    public void setReference(String reference)
            throws PersistenceNotNullException {
        checkForNull(reference);
        
        boolean update = true;
        
        if(this.reference != null) {
            if(this.reference.equals(reference)) {
                update = false;
            }
        } else if(reference == null) {
            update = false;
        }
        
        if(update) {
            this.reference = reference;
            referenceHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getReferenceHasBeenModified() {
        return referenceHasBeenModified;
    }
    
    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;
    }
    
}