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

/**
 * PicklistStatusValue.java
 */

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

import com.echothree.model.data.picklist.common.pk.PicklistStatusPK;

import com.echothree.model.data.picklist.server.factory.PicklistStatusFactory;

import com.echothree.model.data.picklist.common.pk.PicklistPK;

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 PicklistStatusValue
        extends BaseValue<PicklistStatusPK>
        implements Cloneable, Serializable {
    
    private PicklistPK picklistPK;
    private boolean picklistPKHasBeenModified = false;
    private Integer picklistLineSequence;
    private boolean picklistLineSequenceHasBeenModified = false;
    
    private transient Integer _hashCode = null;
    private transient String _stringValue = null;
    
    private void constructFields(PicklistPK picklistPK, Integer picklistLineSequence)
            throws PersistenceNotNullException {
        checkForNull(picklistPK);
        this.picklistPK = picklistPK;
        checkForNull(picklistLineSequence);
        this.picklistLineSequence = picklistLineSequence;
    }
    
    /** Creates a new instance of PicklistStatusValue */
    public PicklistStatusValue(PicklistStatusPK picklistStatusPK, PicklistPK picklistPK, Integer picklistLineSequence)
            throws PersistenceNotNullException {
        super(picklistStatusPK);
        constructFields(picklistPK, picklistLineSequence);
    }
    
    /** Creates a new instance of PicklistStatusValue */
    public PicklistStatusValue(PicklistPK picklistPK, Integer picklistLineSequence)
            throws PersistenceNotNullException {
        super();
        constructFields(picklistPK, picklistLineSequence);
    }
    
   @Override
   public PicklistStatusFactory getBaseFactoryInstance() {
        return PicklistStatusFactory.getInstance();
    }
    
    @Override
    public PicklistStatusValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (PicklistStatusValue)result;
    }
    
   @Override
    public PicklistStatusPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new PicklistStatusPK(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 + ((picklistPK != null) ? picklistPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((picklistLineSequence != null) ? picklistLineSequence.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    public String toString() {
        if(_stringValue == null) {
            StringBuilder stringValue = new StringBuilder("{");
            
            stringValue.append("entityId=").append(getEntityId());
            
            stringValue.append(", picklistPK=").append(getPicklistPK());
            stringValue.append(", picklistLineSequence=").append(getPicklistLineSequence());
            
            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  PicklistStatusValue) {
            PicklistStatusValue that = (PicklistStatusValue)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 PicklistStatusValue) {
            PicklistStatusValue that = (PicklistStatusValue)other;
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                PicklistPK thisPicklistPK = getPicklistPK();
                PicklistPK thatPicklistPK = that.getPicklistPK();
                
                if(thisPicklistPK == null) {
                    objectsEqual = objectsEqual && (thatPicklistPK == null);
                } else {
                    objectsEqual = objectsEqual && thisPicklistPK.equals(thatPicklistPK);
                }
            }
            
            if(objectsEqual) {
                Integer thisPicklistLineSequence = getPicklistLineSequence();
                Integer thatPicklistLineSequence = that.getPicklistLineSequence();
                
                if(thisPicklistLineSequence == null) {
                    objectsEqual = objectsEqual && (thatPicklistLineSequence == null);
                } else {
                    objectsEqual = objectsEqual && thisPicklistLineSequence.equals(thatPicklistLineSequence);
                }
            }
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    @Override
    public boolean hasBeenModified() {
        return picklistPKHasBeenModified || picklistLineSequenceHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        picklistPKHasBeenModified = false;
        picklistLineSequenceHasBeenModified = false;
    }
    
    public PicklistPK getPicklistPK() {
        return picklistPK;
    }
    
    public void setPicklistPK(PicklistPK picklistPK)
            throws PersistenceNotNullException {
        checkForNull(picklistPK);
        
        boolean update = true;
        
        if(this.picklistPK != null) {
            if(this.picklistPK.equals(picklistPK)) {
                update = false;
            }
        } else if(picklistPK == null) {
            update = false;
        }
        
        if(update) {
            this.picklistPK = picklistPK;
            picklistPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getPicklistPKHasBeenModified() {
        return picklistPKHasBeenModified;
    }
    
    public Integer getPicklistLineSequence() {
        return picklistLineSequence;
    }
    
    public void setPicklistLineSequence(Integer picklistLineSequence)
            throws PersistenceNotNullException {
        checkForNull(picklistLineSequence);
        
        boolean update = true;
        
        if(this.picklistLineSequence != null) {
            if(this.picklistLineSequence.equals(picklistLineSequence)) {
                update = false;
            }
        } else if(picklistLineSequence == null) {
            update = false;
        }
        
        if(update) {
            this.picklistLineSequence = picklistLineSequence;
            picklistLineSequenceHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getPicklistLineSequenceHasBeenModified() {
        return picklistLineSequenceHasBeenModified;
    }
    
}