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

/**
 * PartyStatusValue.java
 */

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

import com.echothree.model.data.party.common.pk.PartyStatusPK;

import com.echothree.model.data.party.server.factory.PartyStatusFactory;

import com.echothree.model.data.party.common.pk.PartyPK;

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 PartyStatusValue
        extends BaseValue<PartyStatusPK>
        implements Cloneable, Serializable {
    
    private PartyPK partyPK;
    private boolean partyPKHasBeenModified = false;
    private Integer partyCachedSearchSequence;
    private boolean partyCachedSearchSequenceHasBeenModified = false;
    
    private transient Integer _hashCode = null;
    private transient String _stringValue = null;
    
    private void constructFields(PartyPK partyPK, Integer partyCachedSearchSequence)
            throws PersistenceNotNullException {
        checkForNull(partyPK);
        this.partyPK = partyPK;
        checkForNull(partyCachedSearchSequence);
        this.partyCachedSearchSequence = partyCachedSearchSequence;
    }
    
    /** Creates a new instance of PartyStatusValue */
    public PartyStatusValue(PartyStatusPK partyStatusPK, PartyPK partyPK, Integer partyCachedSearchSequence)
            throws PersistenceNotNullException {
        super(partyStatusPK);
        constructFields(partyPK, partyCachedSearchSequence);
    }
    
    /** Creates a new instance of PartyStatusValue */
    public PartyStatusValue(PartyPK partyPK, Integer partyCachedSearchSequence)
            throws PersistenceNotNullException {
        super();
        constructFields(partyPK, partyCachedSearchSequence);
    }
    
    @Override
    @Nonnull
    public PartyStatusFactory getBaseFactoryInstance() {
        return PartyStatusFactory.getInstance();
    }
    
    @Override
    @Nonnull
    public PartyStatusValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (PartyStatusValue)result;
    }
    
    @Override
    @Nonnull
    public PartyStatusPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new PartyStatusPK(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 + ((partyPK != null) ? partyPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((partyCachedSearchSequence != null) ? partyCachedSearchSequence.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    @Nonnull
    public String toString() {
        if(_stringValue == null) {
            _stringValue = "{" + 
                    "entityId=" + getEntityId() +
                    ", partyPK=" + getPartyPK() +
                    ", partyCachedSearchSequence=" + getPartyCachedSearchSequence() +
                    "}";
        }
        return _stringValue;
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(!hasIdentity())
            return false;
        
        if(other instanceof  PartyStatusValue 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 PartyStatusValue that) {
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                PartyPK thisPartyPK = getPartyPK();
                PartyPK thatPartyPK = that.getPartyPK();
                
                if(thisPartyPK == null) {
                    objectsEqual = objectsEqual && (thatPartyPK == null);
                } else {
                    objectsEqual = objectsEqual && thisPartyPK.equals(thatPartyPK);
                }
            }
            
            if(objectsEqual) {
                Integer thisPartyCachedSearchSequence = getPartyCachedSearchSequence();
                Integer thatPartyCachedSearchSequence = that.getPartyCachedSearchSequence();
                
                if(thisPartyCachedSearchSequence == null) {
                    objectsEqual = objectsEqual && (thatPartyCachedSearchSequence == null);
                } else {
                    objectsEqual = objectsEqual && thisPartyCachedSearchSequence.equals(thatPartyCachedSearchSequence);
                }
            }
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    @Override
    public boolean hasBeenModified() {
        return partyPKHasBeenModified || partyCachedSearchSequenceHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        partyPKHasBeenModified = false;
        partyCachedSearchSequenceHasBeenModified = false;
    }
    
    @Nonnull
    public PartyPK getPartyPK() {
        return partyPK;
    }
    
    public void setPartyPK(@Nonnull PartyPK partyPK)
            throws PersistenceNotNullException {
        checkForNull(partyPK);
        
        boolean update = true;
        
        if(this.partyPK != null) {
            if(this.partyPK.equals(partyPK)) {
                update = false;
            }
        } else if(partyPK == null) {
            update = false;
        }
        
        if(update) {
            this.partyPK = partyPK;
            partyPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getPartyPKHasBeenModified() {
        return partyPKHasBeenModified;
    }
    
    @Nonnull
    public Integer getPartyCachedSearchSequence() {
        return partyCachedSearchSequence;
    }
    
    public void setPartyCachedSearchSequence(@Nonnull Integer partyCachedSearchSequence)
            throws PersistenceNotNullException {
        checkForNull(partyCachedSearchSequence);
        
        boolean update = true;
        
        if(this.partyCachedSearchSequence != null) {
            if(this.partyCachedSearchSequence.equals(partyCachedSearchSequence)) {
                update = false;
            }
        } else if(partyCachedSearchSequence == null) {
            update = false;
        }
        
        if(update) {
            this.partyCachedSearchSequence = partyCachedSearchSequence;
            partyCachedSearchSequenceHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getPartyCachedSearchSequenceHasBeenModified() {
        return partyCachedSearchSequenceHasBeenModified;
    }
    
}