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

/**
 * ContactMechanismPurposeDescriptionValue.java
 */

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

import com.echothree.model.data.contact.common.pk.ContactMechanismPurposeDescriptionPK;

import com.echothree.model.data.contact.server.factory.ContactMechanismPurposeDescriptionFactory;

import com.echothree.model.data.contact.common.pk.ContactMechanismPurposePK;
import com.echothree.model.data.party.common.pk.LanguagePK;

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 ContactMechanismPurposeDescriptionValue
        extends BaseValue<ContactMechanismPurposeDescriptionPK>
        implements Cloneable, Serializable {
    
    private ContactMechanismPurposePK contactMechanismPurposePK;
    private boolean contactMechanismPurposePKHasBeenModified = false;
    private LanguagePK languagePK;
    private boolean languagePKHasBeenModified = false;
    private String description;
    private boolean descriptionHasBeenModified = false;
    
    private transient Integer _hashCode = null;
    private transient String _stringValue = null;
    
    private void constructFields(ContactMechanismPurposePK contactMechanismPurposePK, LanguagePK languagePK, String description)
            throws PersistenceNotNullException {
        checkForNull(contactMechanismPurposePK);
        this.contactMechanismPurposePK = contactMechanismPurposePK;
        checkForNull(languagePK);
        this.languagePK = languagePK;
        checkForNull(description);
        this.description = description;
    }
    
    /** Creates a new instance of ContactMechanismPurposeDescriptionValue */
    public ContactMechanismPurposeDescriptionValue(ContactMechanismPurposeDescriptionPK contactMechanismPurposeDescriptionPK, ContactMechanismPurposePK contactMechanismPurposePK, LanguagePK languagePK, String description)
            throws PersistenceNotNullException {
        super(contactMechanismPurposeDescriptionPK);
        constructFields(contactMechanismPurposePK, languagePK, description);
    }
    
    /** Creates a new instance of ContactMechanismPurposeDescriptionValue */
    public ContactMechanismPurposeDescriptionValue(ContactMechanismPurposePK contactMechanismPurposePK, LanguagePK languagePK, String description)
            throws PersistenceNotNullException {
        super();
        constructFields(contactMechanismPurposePK, languagePK, description);
    }
    
   @Override
   public ContactMechanismPurposeDescriptionFactory getBaseFactoryInstance() {
        return ContactMechanismPurposeDescriptionFactory.getInstance();
    }
    
    @Override
    public ContactMechanismPurposeDescriptionValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (ContactMechanismPurposeDescriptionValue)result;
    }
    
   @Override
    public ContactMechanismPurposeDescriptionPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new ContactMechanismPurposeDescriptionPK(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 + ((contactMechanismPurposePK != null) ? contactMechanismPurposePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((languagePK != null) ? languagePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((description != null) ? description.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    public String toString() {
        if(_stringValue == null) {
            StringBuilder stringValue = new StringBuilder("{");
            
            stringValue.append("entityId=").append(getEntityId());
            
            stringValue.append(", contactMechanismPurposePK=").append(getContactMechanismPurposePK());
            stringValue.append(", languagePK=").append(getLanguagePK());
            stringValue.append(", description=").append(getDescription());
            
            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  ContactMechanismPurposeDescriptionValue) {
            ContactMechanismPurposeDescriptionValue that = (ContactMechanismPurposeDescriptionValue)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 ContactMechanismPurposeDescriptionValue) {
            ContactMechanismPurposeDescriptionValue that = (ContactMechanismPurposeDescriptionValue)other;
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                ContactMechanismPurposePK thisContactMechanismPurposePK = getContactMechanismPurposePK();
                ContactMechanismPurposePK thatContactMechanismPurposePK = that.getContactMechanismPurposePK();
                
                if(thisContactMechanismPurposePK == null) {
                    objectsEqual = objectsEqual && (thatContactMechanismPurposePK == null);
                } else {
                    objectsEqual = objectsEqual && thisContactMechanismPurposePK.equals(thatContactMechanismPurposePK);
                }
            }
            
            if(objectsEqual) {
                LanguagePK thisLanguagePK = getLanguagePK();
                LanguagePK thatLanguagePK = that.getLanguagePK();
                
                if(thisLanguagePK == null) {
                    objectsEqual = objectsEqual && (thatLanguagePK == null);
                } else {
                    objectsEqual = objectsEqual && thisLanguagePK.equals(thatLanguagePK);
                }
            }
            
            if(objectsEqual) {
                String thisDescription = getDescription();
                String thatDescription = that.getDescription();
                
                if(thisDescription == null) {
                    objectsEqual = objectsEqual && (thatDescription == null);
                } else {
                    objectsEqual = objectsEqual && thisDescription.equals(thatDescription);
                }
            }
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    @Override
    public boolean hasBeenModified() {
        return contactMechanismPurposePKHasBeenModified || languagePKHasBeenModified || descriptionHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        contactMechanismPurposePKHasBeenModified = false;
        languagePKHasBeenModified = false;
        descriptionHasBeenModified = false;
    }
    
    public ContactMechanismPurposePK getContactMechanismPurposePK() {
        return contactMechanismPurposePK;
    }
    
    public void setContactMechanismPurposePK(ContactMechanismPurposePK contactMechanismPurposePK)
            throws PersistenceNotNullException {
        checkForNull(contactMechanismPurposePK);
        
        boolean update = true;
        
        if(this.contactMechanismPurposePK != null) {
            if(this.contactMechanismPurposePK.equals(contactMechanismPurposePK)) {
                update = false;
            }
        } else if(contactMechanismPurposePK == null) {
            update = false;
        }
        
        if(update) {
            this.contactMechanismPurposePK = contactMechanismPurposePK;
            contactMechanismPurposePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getContactMechanismPurposePKHasBeenModified() {
        return contactMechanismPurposePKHasBeenModified;
    }
    
    public LanguagePK getLanguagePK() {
        return languagePK;
    }
    
    public void setLanguagePK(LanguagePK languagePK)
            throws PersistenceNotNullException {
        checkForNull(languagePK);
        
        boolean update = true;
        
        if(this.languagePK != null) {
            if(this.languagePK.equals(languagePK)) {
                update = false;
            }
        } else if(languagePK == null) {
            update = false;
        }
        
        if(update) {
            this.languagePK = languagePK;
            languagePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getLanguagePKHasBeenModified() {
        return languagePKHasBeenModified;
    }
    
    public String getDescription() {
        return description;
    }
    
    public void setDescription(String description)
            throws PersistenceNotNullException {
        checkForNull(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;
    }
    
}