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

/**
 * InvoiceDetailValue.java
 */

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

import com.echothree.model.data.invoice.common.pk.InvoiceDetailPK;

import com.echothree.model.data.invoice.server.factory.InvoiceDetailFactory;

import com.echothree.model.data.invoice.common.pk.InvoicePK;
import com.echothree.model.data.invoice.common.pk.InvoiceTypePK;
import com.echothree.model.data.payment.common.pk.BillingAccountPK;
import com.echothree.model.data.accounting.common.pk.GlAccountPK;
import com.echothree.model.data.term.common.pk.TermPK;
import com.echothree.model.data.shipment.common.pk.FreeOnBoardPK;

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 InvoiceDetailValue
        extends BaseValue<InvoiceDetailPK>
        implements Cloneable, Serializable {
    
    private InvoicePK invoicePK;
    private boolean invoicePKHasBeenModified = false;
    private InvoiceTypePK invoiceTypePK;
    private boolean invoiceTypePKHasBeenModified = false;
    private String invoiceName;
    private boolean invoiceNameHasBeenModified = false;
    private BillingAccountPK billingAccountPK;
    private boolean billingAccountPKHasBeenModified = false;
    private GlAccountPK glAccountPK;
    private boolean glAccountPKHasBeenModified = false;
    private TermPK termPK;
    private boolean termPKHasBeenModified = false;
    private FreeOnBoardPK freeOnBoardPK;
    private boolean freeOnBoardPKHasBeenModified = false;
    private String reference;
    private boolean referenceHasBeenModified = false;
    private String description;
    private boolean descriptionHasBeenModified = 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(InvoicePK invoicePK, InvoiceTypePK invoiceTypePK, String invoiceName, BillingAccountPK billingAccountPK, GlAccountPK glAccountPK, TermPK termPK, FreeOnBoardPK freeOnBoardPK, String reference, String description, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        checkForNull(invoicePK);
        this.invoicePK = invoicePK;
        checkForNull(invoiceTypePK);
        this.invoiceTypePK = invoiceTypePK;
        checkForNull(invoiceName);
        this.invoiceName = invoiceName;
        checkForNull(billingAccountPK);
        this.billingAccountPK = billingAccountPK;
        checkForNull(glAccountPK);
        this.glAccountPK = glAccountPK;
        checkForNull(termPK);
        this.termPK = termPK;
        this.freeOnBoardPK = freeOnBoardPK;
        this.reference = reference;
        this.description = description;
        checkForNull(fromTime);
        this.fromTime = fromTime;
        checkForNull(thruTime);
        this.thruTime = thruTime;
    }
    
    /** Creates a new instance of InvoiceDetailValue */
    public InvoiceDetailValue(InvoiceDetailPK invoiceDetailPK, InvoicePK invoicePK, InvoiceTypePK invoiceTypePK, String invoiceName, BillingAccountPK billingAccountPK, GlAccountPK glAccountPK, TermPK termPK, FreeOnBoardPK freeOnBoardPK, String reference, String description, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super(invoiceDetailPK);
        constructFields(invoicePK, invoiceTypePK, invoiceName, billingAccountPK, glAccountPK, termPK, freeOnBoardPK, reference, description, fromTime, thruTime);
    }
    
    /** Creates a new instance of InvoiceDetailValue */
    public InvoiceDetailValue(InvoicePK invoicePK, InvoiceTypePK invoiceTypePK, String invoiceName, BillingAccountPK billingAccountPK, GlAccountPK glAccountPK, TermPK termPK, FreeOnBoardPK freeOnBoardPK, String reference, String description, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super();
        constructFields(invoicePK, invoiceTypePK, invoiceName, billingAccountPK, glAccountPK, termPK, freeOnBoardPK, reference, description, fromTime, thruTime);
    }
    
   @Override
   public InvoiceDetailFactory getBaseFactoryInstance() {
        return InvoiceDetailFactory.getInstance();
    }
    
    @Override
    public InvoiceDetailValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (InvoiceDetailValue)result;
    }
    
   @Override
    public InvoiceDetailPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new InvoiceDetailPK(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 + ((invoicePK != null) ? invoicePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((invoiceTypePK != null) ? invoiceTypePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((invoiceName != null) ? invoiceName.hashCode() : 0);
            hashCode = 37 * hashCode + ((billingAccountPK != null) ? billingAccountPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((glAccountPK != null) ? glAccountPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((termPK != null) ? termPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((freeOnBoardPK != null) ? freeOnBoardPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((reference != null) ? reference.hashCode() : 0);
            hashCode = 37 * hashCode + ((description != null) ? description.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(", invoicePK=").append(getInvoicePK());
            stringValue.append(", invoiceTypePK=").append(getInvoiceTypePK());
            stringValue.append(", invoiceName=").append(getInvoiceName());
            stringValue.append(", billingAccountPK=").append(getBillingAccountPK());
            stringValue.append(", glAccountPK=").append(getGlAccountPK());
            stringValue.append(", termPK=").append(getTermPK());
            stringValue.append(", freeOnBoardPK=").append(getFreeOnBoardPK());
            stringValue.append(", reference=").append(getReference());
            stringValue.append(", description=").append(getDescription());
            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  InvoiceDetailValue) {
            InvoiceDetailValue that = (InvoiceDetailValue)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 InvoiceDetailValue) {
            InvoiceDetailValue that = (InvoiceDetailValue)other;
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                InvoicePK thisInvoicePK = getInvoicePK();
                InvoicePK thatInvoicePK = that.getInvoicePK();
                
                if(thisInvoicePK == null) {
                    objectsEqual = objectsEqual && (thatInvoicePK == null);
                } else {
                    objectsEqual = objectsEqual && thisInvoicePK.equals(thatInvoicePK);
                }
            }
            
            if(objectsEqual) {
                InvoiceTypePK thisInvoiceTypePK = getInvoiceTypePK();
                InvoiceTypePK thatInvoiceTypePK = that.getInvoiceTypePK();
                
                if(thisInvoiceTypePK == null) {
                    objectsEqual = objectsEqual && (thatInvoiceTypePK == null);
                } else {
                    objectsEqual = objectsEqual && thisInvoiceTypePK.equals(thatInvoiceTypePK);
                }
            }
            
            if(objectsEqual) {
                String thisInvoiceName = getInvoiceName();
                String thatInvoiceName = that.getInvoiceName();
                
                if(thisInvoiceName == null) {
                    objectsEqual = objectsEqual && (thatInvoiceName == null);
                } else {
                    objectsEqual = objectsEqual && thisInvoiceName.equals(thatInvoiceName);
                }
            }
            
            if(objectsEqual) {
                BillingAccountPK thisBillingAccountPK = getBillingAccountPK();
                BillingAccountPK thatBillingAccountPK = that.getBillingAccountPK();
                
                if(thisBillingAccountPK == null) {
                    objectsEqual = objectsEqual && (thatBillingAccountPK == null);
                } else {
                    objectsEqual = objectsEqual && thisBillingAccountPK.equals(thatBillingAccountPK);
                }
            }
            
            if(objectsEqual) {
                GlAccountPK thisGlAccountPK = getGlAccountPK();
                GlAccountPK thatGlAccountPK = that.getGlAccountPK();
                
                if(thisGlAccountPK == null) {
                    objectsEqual = objectsEqual && (thatGlAccountPK == null);
                } else {
                    objectsEqual = objectsEqual && thisGlAccountPK.equals(thatGlAccountPK);
                }
            }
            
            if(objectsEqual) {
                TermPK thisTermPK = getTermPK();
                TermPK thatTermPK = that.getTermPK();
                
                if(thisTermPK == null) {
                    objectsEqual = objectsEqual && (thatTermPK == null);
                } else {
                    objectsEqual = objectsEqual && thisTermPK.equals(thatTermPK);
                }
            }
            
            if(objectsEqual) {
                FreeOnBoardPK thisFreeOnBoardPK = getFreeOnBoardPK();
                FreeOnBoardPK thatFreeOnBoardPK = that.getFreeOnBoardPK();
                
                if(thisFreeOnBoardPK == null) {
                    objectsEqual = objectsEqual && (thatFreeOnBoardPK == null);
                } else {
                    objectsEqual = objectsEqual && thisFreeOnBoardPK.equals(thatFreeOnBoardPK);
                }
            }
            
            if(objectsEqual) {
                String thisReference = getReference();
                String thatReference = that.getReference();
                
                if(thisReference == null) {
                    objectsEqual = objectsEqual && (thatReference == null);
                } else {
                    objectsEqual = objectsEqual && thisReference.equals(thatReference);
                }
            }
            
            if(objectsEqual) {
                String thisDescription = getDescription();
                String thatDescription = that.getDescription();
                
                if(thisDescription == null) {
                    objectsEqual = objectsEqual && (thatDescription == null);
                } else {
                    objectsEqual = objectsEqual && thisDescription.equals(thatDescription);
                }
            }
            
            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 invoicePKHasBeenModified || invoiceTypePKHasBeenModified || invoiceNameHasBeenModified || billingAccountPKHasBeenModified || glAccountPKHasBeenModified || termPKHasBeenModified || freeOnBoardPKHasBeenModified || referenceHasBeenModified || descriptionHasBeenModified || fromTimeHasBeenModified || thruTimeHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        invoicePKHasBeenModified = false;
        invoiceTypePKHasBeenModified = false;
        invoiceNameHasBeenModified = false;
        billingAccountPKHasBeenModified = false;
        glAccountPKHasBeenModified = false;
        termPKHasBeenModified = false;
        freeOnBoardPKHasBeenModified = false;
        referenceHasBeenModified = false;
        descriptionHasBeenModified = false;
        fromTimeHasBeenModified = false;
        thruTimeHasBeenModified = false;
    }
    
    public InvoicePK getInvoicePK() {
        return invoicePK;
    }
    
    public void setInvoicePK(InvoicePK invoicePK)
            throws PersistenceNotNullException {
        checkForNull(invoicePK);
        
        boolean update = true;
        
        if(this.invoicePK != null) {
            if(this.invoicePK.equals(invoicePK)) {
                update = false;
            }
        } else if(invoicePK == null) {
            update = false;
        }
        
        if(update) {
            this.invoicePK = invoicePK;
            invoicePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getInvoicePKHasBeenModified() {
        return invoicePKHasBeenModified;
    }
    
    public InvoiceTypePK getInvoiceTypePK() {
        return invoiceTypePK;
    }
    
    public void setInvoiceTypePK(InvoiceTypePK invoiceTypePK)
            throws PersistenceNotNullException {
        checkForNull(invoiceTypePK);
        
        boolean update = true;
        
        if(this.invoiceTypePK != null) {
            if(this.invoiceTypePK.equals(invoiceTypePK)) {
                update = false;
            }
        } else if(invoiceTypePK == null) {
            update = false;
        }
        
        if(update) {
            this.invoiceTypePK = invoiceTypePK;
            invoiceTypePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getInvoiceTypePKHasBeenModified() {
        return invoiceTypePKHasBeenModified;
    }
    
    public String getInvoiceName() {
        return invoiceName;
    }
    
    public void setInvoiceName(String invoiceName)
            throws PersistenceNotNullException {
        checkForNull(invoiceName);
        
        boolean update = true;
        
        if(this.invoiceName != null) {
            if(this.invoiceName.equals(invoiceName)) {
                update = false;
            }
        } else if(invoiceName == null) {
            update = false;
        }
        
        if(update) {
            this.invoiceName = invoiceName;
            invoiceNameHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getInvoiceNameHasBeenModified() {
        return invoiceNameHasBeenModified;
    }
    
    public BillingAccountPK getBillingAccountPK() {
        return billingAccountPK;
    }
    
    public void setBillingAccountPK(BillingAccountPK billingAccountPK)
            throws PersistenceNotNullException {
        checkForNull(billingAccountPK);
        
        boolean update = true;
        
        if(this.billingAccountPK != null) {
            if(this.billingAccountPK.equals(billingAccountPK)) {
                update = false;
            }
        } else if(billingAccountPK == null) {
            update = false;
        }
        
        if(update) {
            this.billingAccountPK = billingAccountPK;
            billingAccountPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getBillingAccountPKHasBeenModified() {
        return billingAccountPKHasBeenModified;
    }
    
    public GlAccountPK getGlAccountPK() {
        return glAccountPK;
    }
    
    public void setGlAccountPK(GlAccountPK glAccountPK)
            throws PersistenceNotNullException {
        checkForNull(glAccountPK);
        
        boolean update = true;
        
        if(this.glAccountPK != null) {
            if(this.glAccountPK.equals(glAccountPK)) {
                update = false;
            }
        } else if(glAccountPK == null) {
            update = false;
        }
        
        if(update) {
            this.glAccountPK = glAccountPK;
            glAccountPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getGlAccountPKHasBeenModified() {
        return glAccountPKHasBeenModified;
    }
    
    public TermPK getTermPK() {
        return termPK;
    }
    
    public void setTermPK(TermPK termPK)
            throws PersistenceNotNullException {
        checkForNull(termPK);
        
        boolean update = true;
        
        if(this.termPK != null) {
            if(this.termPK.equals(termPK)) {
                update = false;
            }
        } else if(termPK == null) {
            update = false;
        }
        
        if(update) {
            this.termPK = termPK;
            termPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getTermPKHasBeenModified() {
        return termPKHasBeenModified;
    }
    
    public FreeOnBoardPK getFreeOnBoardPK() {
        return freeOnBoardPK;
    }
    
    public void setFreeOnBoardPK(FreeOnBoardPK freeOnBoardPK) {
        boolean update = true;
        
        if(this.freeOnBoardPK != null) {
            if(this.freeOnBoardPK.equals(freeOnBoardPK)) {
                update = false;
            }
        } else if(freeOnBoardPK == null) {
            update = false;
        }
        
        if(update) {
            this.freeOnBoardPK = freeOnBoardPK;
            freeOnBoardPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getFreeOnBoardPKHasBeenModified() {
        return freeOnBoardPKHasBeenModified;
    }
    
    public String getReference() {
        return reference;
    }
    
    public void setReference(String 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 String getDescription() {
        return description;
    }
    
    public void setDescription(String description) {
        boolean update = true;
        
        if(this.description != null) {
            if(this.description.equals(description)) {
                update = false;
            }
        } else if(description == null) {
            update = false;
        }
        
        if(update) {
            this.description = description;
            descriptionHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getDescriptionHasBeenModified() {
        return descriptionHasBeenModified;
    }
    
    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;
    }
    
}