// --------------------------------------------------------------------------------
// Copyright 2002-2025 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
// --------------------------------------------------------------------------------

/**
 * ForumMessageStatusValue.java
 */

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

import com.echothree.model.data.forum.common.pk.ForumMessageStatusPK;

import com.echothree.model.data.forum.server.factory.ForumMessageStatusFactory;

import com.echothree.model.data.forum.common.pk.ForumMessagePK;

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 ForumMessageStatusValue
        extends BaseValue<ForumMessageStatusPK>
        implements Cloneable, Serializable {
    
    private ForumMessagePK forumMessagePK;
    private boolean forumMessagePKHasBeenModified = false;
    private Integer forumMessageAttachmentSequence;
    private boolean forumMessageAttachmentSequenceHasBeenModified = false;
    
    private transient Integer _hashCode = null;
    private transient String _stringValue = null;
    
    private void constructFields(ForumMessagePK forumMessagePK, Integer forumMessageAttachmentSequence)
            throws PersistenceNotNullException {
        checkForNull(forumMessagePK);
        this.forumMessagePK = forumMessagePK;
        checkForNull(forumMessageAttachmentSequence);
        this.forumMessageAttachmentSequence = forumMessageAttachmentSequence;
    }
    
    /** Creates a new instance of ForumMessageStatusValue */
    public ForumMessageStatusValue(ForumMessageStatusPK forumMessageStatusPK, ForumMessagePK forumMessagePK, Integer forumMessageAttachmentSequence)
            throws PersistenceNotNullException {
        super(forumMessageStatusPK);
        constructFields(forumMessagePK, forumMessageAttachmentSequence);
    }
    
    /** Creates a new instance of ForumMessageStatusValue */
    public ForumMessageStatusValue(ForumMessagePK forumMessagePK, Integer forumMessageAttachmentSequence)
            throws PersistenceNotNullException {
        super();
        constructFields(forumMessagePK, forumMessageAttachmentSequence);
    }
    
   @Override
   public ForumMessageStatusFactory getBaseFactoryInstance() {
        return ForumMessageStatusFactory.getInstance();
    }
    
    @Override
    public ForumMessageStatusValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (ForumMessageStatusValue)result;
    }
    
   @Override
    public ForumMessageStatusPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new ForumMessageStatusPK(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 + ((forumMessagePK != null) ? forumMessagePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((forumMessageAttachmentSequence != null) ? forumMessageAttachmentSequence.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    public String toString() {
        if(_stringValue == null) {
            _stringValue = "{" + 
                    "entityId=" + getEntityId() +
                    ", forumMessagePK=" + getForumMessagePK() +
                    ", forumMessageAttachmentSequence=" + getForumMessageAttachmentSequence() +
                    "}";
        }
        return _stringValue;
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(!hasIdentity())
            return false;
        
        if(other instanceof  ForumMessageStatusValue 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 ForumMessageStatusValue that) {
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                ForumMessagePK thisForumMessagePK = getForumMessagePK();
                ForumMessagePK thatForumMessagePK = that.getForumMessagePK();
                
                if(thisForumMessagePK == null) {
                    objectsEqual = objectsEqual && (thatForumMessagePK == null);
                } else {
                    objectsEqual = objectsEqual && thisForumMessagePK.equals(thatForumMessagePK);
                }
            }
            
            if(objectsEqual) {
                Integer thisForumMessageAttachmentSequence = getForumMessageAttachmentSequence();
                Integer thatForumMessageAttachmentSequence = that.getForumMessageAttachmentSequence();
                
                if(thisForumMessageAttachmentSequence == null) {
                    objectsEqual = objectsEqual && (thatForumMessageAttachmentSequence == null);
                } else {
                    objectsEqual = objectsEqual && thisForumMessageAttachmentSequence.equals(thatForumMessageAttachmentSequence);
                }
            }
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    @Override
    public boolean hasBeenModified() {
        return forumMessagePKHasBeenModified || forumMessageAttachmentSequenceHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        forumMessagePKHasBeenModified = false;
        forumMessageAttachmentSequenceHasBeenModified = false;
    }
    
    public ForumMessagePK getForumMessagePK() {
        return forumMessagePK;
    }
    
    public void setForumMessagePK(ForumMessagePK forumMessagePK)
            throws PersistenceNotNullException {
        checkForNull(forumMessagePK);
        
        boolean update = true;
        
        if(this.forumMessagePK != null) {
            if(this.forumMessagePK.equals(forumMessagePK)) {
                update = false;
            }
        } else if(forumMessagePK == null) {
            update = false;
        }
        
        if(update) {
            this.forumMessagePK = forumMessagePK;
            forumMessagePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getForumMessagePKHasBeenModified() {
        return forumMessagePKHasBeenModified;
    }
    
    public Integer getForumMessageAttachmentSequence() {
        return forumMessageAttachmentSequence;
    }
    
    public void setForumMessageAttachmentSequence(Integer forumMessageAttachmentSequence)
            throws PersistenceNotNullException {
        checkForNull(forumMessageAttachmentSequence);
        
        boolean update = true;
        
        if(this.forumMessageAttachmentSequence != null) {
            if(this.forumMessageAttachmentSequence.equals(forumMessageAttachmentSequence)) {
                update = false;
            }
        } else if(forumMessageAttachmentSequence == null) {
            update = false;
        }
        
        if(update) {
            this.forumMessageAttachmentSequence = forumMessageAttachmentSequence;
            forumMessageAttachmentSequenceHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getForumMessageAttachmentSequenceHasBeenModified() {
        return forumMessageAttachmentSequenceHasBeenModified;
    }
    
}