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

/**
 * InvoiceStatusValue.java
 */

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

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

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

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

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 InvoiceStatusValue
        extends BaseValue<InvoiceStatusPK>
        implements Cloneable, Serializable {
    
    private InvoicePK invoicePK;
    private boolean invoicePKHasBeenModified = false;
    private Integer invoiceLineSequence;
    private boolean invoiceLineSequenceHasBeenModified = false;
    
    private transient Integer _hashCode = null;
    private transient String _stringValue = null;
    
    private void constructFields(InvoicePK invoicePK, Integer invoiceLineSequence)
            throws PersistenceNotNullException {
        checkForNull(invoicePK);
        this.invoicePK = invoicePK;
        checkForNull(invoiceLineSequence);
        this.invoiceLineSequence = invoiceLineSequence;
    }
    
    /** Creates a new instance of InvoiceStatusValue */
    public InvoiceStatusValue(InvoiceStatusPK invoiceStatusPK, InvoicePK invoicePK, Integer invoiceLineSequence)
            throws PersistenceNotNullException {
        super(invoiceStatusPK);
        constructFields(invoicePK, invoiceLineSequence);
    }
    
    /** Creates a new instance of InvoiceStatusValue */
    public InvoiceStatusValue(InvoicePK invoicePK, Integer invoiceLineSequence)
            throws PersistenceNotNullException {
        super();
        constructFields(invoicePK, invoiceLineSequence);
    }
    
    @Override
    @Nonnull
    public InvoiceStatusFactory getBaseFactoryInstance() {
        return InvoiceStatusFactory.getInstance();
    }
    
    @Override
    @Nonnull
    public InvoiceStatusValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (InvoiceStatusValue)result;
    }
    
    @Override
    @Nonnull
    public InvoiceStatusPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new InvoiceStatusPK(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 + ((invoiceLineSequence != null) ? invoiceLineSequence.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    @Nonnull
    public String toString() {
        if(_stringValue == null) {
            _stringValue = "{" + 
                    "entityId=" + getEntityId() +
                    ", invoicePK=" + getInvoicePK() +
                    ", invoiceLineSequence=" + getInvoiceLineSequence() +
                    "}";
        }
        return _stringValue;
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(!hasIdentity())
            return false;
        
        if(other instanceof  InvoiceStatusValue 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 InvoiceStatusValue that) {
            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) {
                Integer thisInvoiceLineSequence = getInvoiceLineSequence();
                Integer thatInvoiceLineSequence = that.getInvoiceLineSequence();
                
                if(thisInvoiceLineSequence == null) {
                    objectsEqual = objectsEqual && (thatInvoiceLineSequence == null);
                } else {
                    objectsEqual = objectsEqual && thisInvoiceLineSequence.equals(thatInvoiceLineSequence);
                }
            }
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    @Override
    public boolean hasBeenModified() {
        return invoicePKHasBeenModified || invoiceLineSequenceHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        invoicePKHasBeenModified = false;
        invoiceLineSequenceHasBeenModified = false;
    }
    
    @Nonnull
    public InvoicePK getInvoicePK() {
        return invoicePK;
    }
    
    public void setInvoicePK(@Nonnull 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;
    }
    
    @Nonnull
    public Integer getInvoiceLineSequence() {
        return invoiceLineSequence;
    }
    
    public void setInvoiceLineSequence(@Nonnull Integer invoiceLineSequence)
            throws PersistenceNotNullException {
        checkForNull(invoiceLineSequence);
        
        boolean update = true;
        
        if(this.invoiceLineSequence != null) {
            if(this.invoiceLineSequence.equals(invoiceLineSequence)) {
                update = false;
            }
        } else if(invoiceLineSequence == null) {
            update = false;
        }
        
        if(update) {
            this.invoiceLineSequence = invoiceLineSequence;
            invoiceLineSequenceHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getInvoiceLineSequenceHasBeenModified() {
        return invoiceLineSequenceHasBeenModified;
    }
    
}