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

/**
 * UserVisitCampaignValue.java
 */

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

import com.echothree.model.data.campaign.common.pk.UserVisitCampaignPK;

import com.echothree.model.data.campaign.server.factory.UserVisitCampaignFactory;

import com.echothree.model.data.user.common.pk.UserVisitPK;
import com.echothree.model.data.campaign.common.pk.CampaignPK;
import com.echothree.model.data.campaign.common.pk.CampaignSourcePK;
import com.echothree.model.data.campaign.common.pk.CampaignMediumPK;
import com.echothree.model.data.campaign.common.pk.CampaignTermPK;
import com.echothree.model.data.campaign.common.pk.CampaignContentPK;

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 UserVisitCampaignValue
        extends BaseValue<UserVisitCampaignPK>
        implements Cloneable, Serializable {
    
    private UserVisitPK userVisitPK;
    private boolean userVisitPKHasBeenModified = false;
    private Integer userVisitCampaignSequence;
    private boolean userVisitCampaignSequenceHasBeenModified = false;
    private Long time;
    private boolean timeHasBeenModified = false;
    private CampaignPK campaignPK;
    private boolean campaignPKHasBeenModified = false;
    private CampaignSourcePK campaignSourcePK;
    private boolean campaignSourcePKHasBeenModified = false;
    private CampaignMediumPK campaignMediumPK;
    private boolean campaignMediumPKHasBeenModified = false;
    private CampaignTermPK campaignTermPK;
    private boolean campaignTermPKHasBeenModified = false;
    private CampaignContentPK campaignContentPK;
    private boolean campaignContentPKHasBeenModified = false;
    private Long fromTime;
    private boolean fromTimeHasBeenModified = false;
    private Long thruTime;
    private boolean thruTimeHasBeenModified = false;
    
    private transient Integer _hashCode = null;
    private transient String _stringValue = null;
    
    private void constructFields(UserVisitPK userVisitPK, Integer userVisitCampaignSequence, Long time, CampaignPK campaignPK, CampaignSourcePK campaignSourcePK, CampaignMediumPK campaignMediumPK, CampaignTermPK campaignTermPK, CampaignContentPK campaignContentPK, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        checkForNull(userVisitPK);
        this.userVisitPK = userVisitPK;
        checkForNull(userVisitCampaignSequence);
        this.userVisitCampaignSequence = userVisitCampaignSequence;
        checkForNull(time);
        this.time = time;
        this.campaignPK = campaignPK;
        this.campaignSourcePK = campaignSourcePK;
        this.campaignMediumPK = campaignMediumPK;
        this.campaignTermPK = campaignTermPK;
        this.campaignContentPK = campaignContentPK;
        checkForNull(fromTime);
        this.fromTime = fromTime;
        checkForNull(thruTime);
        this.thruTime = thruTime;
    }
    
    /** Creates a new instance of UserVisitCampaignValue */
    public UserVisitCampaignValue(UserVisitCampaignPK userVisitCampaignPK, UserVisitPK userVisitPK, Integer userVisitCampaignSequence, Long time, CampaignPK campaignPK, CampaignSourcePK campaignSourcePK, CampaignMediumPK campaignMediumPK, CampaignTermPK campaignTermPK, CampaignContentPK campaignContentPK, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super(userVisitCampaignPK);
        constructFields(userVisitPK, userVisitCampaignSequence, time, campaignPK, campaignSourcePK, campaignMediumPK, campaignTermPK, campaignContentPK, fromTime, thruTime);
    }
    
    /** Creates a new instance of UserVisitCampaignValue */
    public UserVisitCampaignValue(UserVisitPK userVisitPK, Integer userVisitCampaignSequence, Long time, CampaignPK campaignPK, CampaignSourcePK campaignSourcePK, CampaignMediumPK campaignMediumPK, CampaignTermPK campaignTermPK, CampaignContentPK campaignContentPK, Long fromTime, Long thruTime)
            throws PersistenceNotNullException {
        super();
        constructFields(userVisitPK, userVisitCampaignSequence, time, campaignPK, campaignSourcePK, campaignMediumPK, campaignTermPK, campaignContentPK, fromTime, thruTime);
    }
    
   @Override
   public UserVisitCampaignFactory getBaseFactoryInstance() {
        return UserVisitCampaignFactory.getInstance();
    }
    
    @Override
    public UserVisitCampaignValue clone() {
        Object result;
        
        try {
            result = super.clone();
        } catch (CloneNotSupportedException cnse) {
            // This shouldn't happen, fail when it does.
            throw new PersistenceCloneException(cnse);
        }
        
        return (UserVisitCampaignValue)result;
    }
    
   @Override
    public UserVisitCampaignPK getPrimaryKey() {
        if(_primaryKey == null) {
            _primaryKey = new UserVisitCampaignPK(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 + ((userVisitPK != null) ? userVisitPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((userVisitCampaignSequence != null) ? userVisitCampaignSequence.hashCode() : 0);
            hashCode = 37 * hashCode + ((time != null) ? time.hashCode() : 0);
            hashCode = 37 * hashCode + ((campaignPK != null) ? campaignPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((campaignSourcePK != null) ? campaignSourcePK.hashCode() : 0);
            hashCode = 37 * hashCode + ((campaignMediumPK != null) ? campaignMediumPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((campaignTermPK != null) ? campaignTermPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((campaignContentPK != null) ? campaignContentPK.hashCode() : 0);
            hashCode = 37 * hashCode + ((fromTime != null) ? fromTime.hashCode() : 0);
            hashCode = 37 * hashCode + ((thruTime != null) ? thruTime.hashCode() : 0);
            
            _hashCode = hashCode;
        }
        
        return _hashCode;
    }
    
    @Override
    public String toString() {
        if(_stringValue == null) {
            StringBuilder stringValue = new StringBuilder("{");
            
            stringValue.append("entityId=").append(getEntityId());
            
            stringValue.append(", userVisitPK=").append(getUserVisitPK());
            stringValue.append(", userVisitCampaignSequence=").append(getUserVisitCampaignSequence());
            stringValue.append(", time=").append(getTime());
            stringValue.append(", campaignPK=").append(getCampaignPK());
            stringValue.append(", campaignSourcePK=").append(getCampaignSourcePK());
            stringValue.append(", campaignMediumPK=").append(getCampaignMediumPK());
            stringValue.append(", campaignTermPK=").append(getCampaignTermPK());
            stringValue.append(", campaignContentPK=").append(getCampaignContentPK());
            stringValue.append(", fromTime=").append(getFromTime());
            stringValue.append(", thruTime=").append(getThruTime());
            
            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  UserVisitCampaignValue) {
            UserVisitCampaignValue that = (UserVisitCampaignValue)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 UserVisitCampaignValue) {
            UserVisitCampaignValue that = (UserVisitCampaignValue)other;
            boolean objectsEqual = true;
            
            
            if(objectsEqual) {
                UserVisitPK thisUserVisitPK = getUserVisitPK();
                UserVisitPK thatUserVisitPK = that.getUserVisitPK();
                
                if(thisUserVisitPK == null) {
                    objectsEqual = objectsEqual && (thatUserVisitPK == null);
                } else {
                    objectsEqual = objectsEqual && thisUserVisitPK.equals(thatUserVisitPK);
                }
            }
            
            if(objectsEqual) {
                Integer thisUserVisitCampaignSequence = getUserVisitCampaignSequence();
                Integer thatUserVisitCampaignSequence = that.getUserVisitCampaignSequence();
                
                if(thisUserVisitCampaignSequence == null) {
                    objectsEqual = objectsEqual && (thatUserVisitCampaignSequence == null);
                } else {
                    objectsEqual = objectsEqual && thisUserVisitCampaignSequence.equals(thatUserVisitCampaignSequence);
                }
            }
            
            if(objectsEqual) {
                Long thisTime = getTime();
                Long thatTime = that.getTime();
                
                if(thisTime == null) {
                    objectsEqual = objectsEqual && (thatTime == null);
                } else {
                    objectsEqual = objectsEqual && thisTime.equals(thatTime);
                }
            }
            
            if(objectsEqual) {
                CampaignPK thisCampaignPK = getCampaignPK();
                CampaignPK thatCampaignPK = that.getCampaignPK();
                
                if(thisCampaignPK == null) {
                    objectsEqual = objectsEqual && (thatCampaignPK == null);
                } else {
                    objectsEqual = objectsEqual && thisCampaignPK.equals(thatCampaignPK);
                }
            }
            
            if(objectsEqual) {
                CampaignSourcePK thisCampaignSourcePK = getCampaignSourcePK();
                CampaignSourcePK thatCampaignSourcePK = that.getCampaignSourcePK();
                
                if(thisCampaignSourcePK == null) {
                    objectsEqual = objectsEqual && (thatCampaignSourcePK == null);
                } else {
                    objectsEqual = objectsEqual && thisCampaignSourcePK.equals(thatCampaignSourcePK);
                }
            }
            
            if(objectsEqual) {
                CampaignMediumPK thisCampaignMediumPK = getCampaignMediumPK();
                CampaignMediumPK thatCampaignMediumPK = that.getCampaignMediumPK();
                
                if(thisCampaignMediumPK == null) {
                    objectsEqual = objectsEqual && (thatCampaignMediumPK == null);
                } else {
                    objectsEqual = objectsEqual && thisCampaignMediumPK.equals(thatCampaignMediumPK);
                }
            }
            
            if(objectsEqual) {
                CampaignTermPK thisCampaignTermPK = getCampaignTermPK();
                CampaignTermPK thatCampaignTermPK = that.getCampaignTermPK();
                
                if(thisCampaignTermPK == null) {
                    objectsEqual = objectsEqual && (thatCampaignTermPK == null);
                } else {
                    objectsEqual = objectsEqual && thisCampaignTermPK.equals(thatCampaignTermPK);
                }
            }
            
            if(objectsEqual) {
                CampaignContentPK thisCampaignContentPK = getCampaignContentPK();
                CampaignContentPK thatCampaignContentPK = that.getCampaignContentPK();
                
                if(thisCampaignContentPK == null) {
                    objectsEqual = objectsEqual && (thatCampaignContentPK == null);
                } else {
                    objectsEqual = objectsEqual && thisCampaignContentPK.equals(thatCampaignContentPK);
                }
            }
            
            if(objectsEqual) {
                Long thisFromTime = getFromTime();
                Long thatFromTime = that.getFromTime();
                
                if(thisFromTime == null) {
                    objectsEqual = objectsEqual && (thatFromTime == null);
                } else {
                    objectsEqual = objectsEqual && thisFromTime.equals(thatFromTime);
                }
            }
            
            if(objectsEqual) {
                Long thisThruTime = getThruTime();
                Long thatThruTime = that.getThruTime();
                
                if(thisThruTime == null) {
                    objectsEqual = objectsEqual && (thatThruTime == null);
                } else {
                    objectsEqual = objectsEqual && thisThruTime.equals(thatThruTime);
                }
            }
            
            return objectsEqual;
        } else {
            return false;
        }
    }
    
    @Override
    public boolean hasBeenModified() {
        return userVisitPKHasBeenModified || userVisitCampaignSequenceHasBeenModified || timeHasBeenModified || campaignPKHasBeenModified || campaignSourcePKHasBeenModified || campaignMediumPKHasBeenModified || campaignTermPKHasBeenModified || campaignContentPKHasBeenModified || fromTimeHasBeenModified || thruTimeHasBeenModified;
    }
    
    @Override
    public void clearHasBeenModified() {
        userVisitPKHasBeenModified = false;
        userVisitCampaignSequenceHasBeenModified = false;
        timeHasBeenModified = false;
        campaignPKHasBeenModified = false;
        campaignSourcePKHasBeenModified = false;
        campaignMediumPKHasBeenModified = false;
        campaignTermPKHasBeenModified = false;
        campaignContentPKHasBeenModified = false;
        fromTimeHasBeenModified = false;
        thruTimeHasBeenModified = false;
    }
    
    public UserVisitPK getUserVisitPK() {
        return userVisitPK;
    }
    
    public void setUserVisitPK(UserVisitPK userVisitPK)
            throws PersistenceNotNullException {
        checkForNull(userVisitPK);
        
        boolean update = true;
        
        if(this.userVisitPK != null) {
            if(this.userVisitPK.equals(userVisitPK)) {
                update = false;
            }
        } else if(userVisitPK == null) {
            update = false;
        }
        
        if(update) {
            this.userVisitPK = userVisitPK;
            userVisitPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getUserVisitPKHasBeenModified() {
        return userVisitPKHasBeenModified;
    }
    
    public Integer getUserVisitCampaignSequence() {
        return userVisitCampaignSequence;
    }
    
    public void setUserVisitCampaignSequence(Integer userVisitCampaignSequence)
            throws PersistenceNotNullException {
        checkForNull(userVisitCampaignSequence);
        
        boolean update = true;
        
        if(this.userVisitCampaignSequence != null) {
            if(this.userVisitCampaignSequence.equals(userVisitCampaignSequence)) {
                update = false;
            }
        } else if(userVisitCampaignSequence == null) {
            update = false;
        }
        
        if(update) {
            this.userVisitCampaignSequence = userVisitCampaignSequence;
            userVisitCampaignSequenceHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getUserVisitCampaignSequenceHasBeenModified() {
        return userVisitCampaignSequenceHasBeenModified;
    }
    
    public Long getTime() {
        return time;
    }
    
    public void setTime(Long time)
            throws PersistenceNotNullException {
        checkForNull(time);
        
        boolean update = true;
        
        if(this.time != null) {
            if(this.time.equals(time)) {
                update = false;
            }
        } else if(time == null) {
            update = false;
        }
        
        if(update) {
            this.time = time;
            timeHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getTimeHasBeenModified() {
        return timeHasBeenModified;
    }
    
    public CampaignPK getCampaignPK() {
        return campaignPK;
    }
    
    public void setCampaignPK(CampaignPK campaignPK) {
        boolean update = true;
        
        if(this.campaignPK != null) {
            if(this.campaignPK.equals(campaignPK)) {
                update = false;
            }
        } else if(campaignPK == null) {
            update = false;
        }
        
        if(update) {
            this.campaignPK = campaignPK;
            campaignPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getCampaignPKHasBeenModified() {
        return campaignPKHasBeenModified;
    }
    
    public CampaignSourcePK getCampaignSourcePK() {
        return campaignSourcePK;
    }
    
    public void setCampaignSourcePK(CampaignSourcePK campaignSourcePK) {
        boolean update = true;
        
        if(this.campaignSourcePK != null) {
            if(this.campaignSourcePK.equals(campaignSourcePK)) {
                update = false;
            }
        } else if(campaignSourcePK == null) {
            update = false;
        }
        
        if(update) {
            this.campaignSourcePK = campaignSourcePK;
            campaignSourcePKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getCampaignSourcePKHasBeenModified() {
        return campaignSourcePKHasBeenModified;
    }
    
    public CampaignMediumPK getCampaignMediumPK() {
        return campaignMediumPK;
    }
    
    public void setCampaignMediumPK(CampaignMediumPK campaignMediumPK) {
        boolean update = true;
        
        if(this.campaignMediumPK != null) {
            if(this.campaignMediumPK.equals(campaignMediumPK)) {
                update = false;
            }
        } else if(campaignMediumPK == null) {
            update = false;
        }
        
        if(update) {
            this.campaignMediumPK = campaignMediumPK;
            campaignMediumPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getCampaignMediumPKHasBeenModified() {
        return campaignMediumPKHasBeenModified;
    }
    
    public CampaignTermPK getCampaignTermPK() {
        return campaignTermPK;
    }
    
    public void setCampaignTermPK(CampaignTermPK campaignTermPK) {
        boolean update = true;
        
        if(this.campaignTermPK != null) {
            if(this.campaignTermPK.equals(campaignTermPK)) {
                update = false;
            }
        } else if(campaignTermPK == null) {
            update = false;
        }
        
        if(update) {
            this.campaignTermPK = campaignTermPK;
            campaignTermPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getCampaignTermPKHasBeenModified() {
        return campaignTermPKHasBeenModified;
    }
    
    public CampaignContentPK getCampaignContentPK() {
        return campaignContentPK;
    }
    
    public void setCampaignContentPK(CampaignContentPK campaignContentPK) {
        boolean update = true;
        
        if(this.campaignContentPK != null) {
            if(this.campaignContentPK.equals(campaignContentPK)) {
                update = false;
            }
        } else if(campaignContentPK == null) {
            update = false;
        }
        
        if(update) {
            this.campaignContentPK = campaignContentPK;
            campaignContentPKHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getCampaignContentPKHasBeenModified() {
        return campaignContentPKHasBeenModified;
    }
    
    public Long getFromTime() {
        return fromTime;
    }
    
    public void setFromTime(Long fromTime)
            throws PersistenceNotNullException {
        checkForNull(fromTime);
        
        boolean update = true;
        
        if(this.fromTime != null) {
            if(this.fromTime.equals(fromTime)) {
                update = false;
            }
        } else if(fromTime == null) {
            update = false;
        }
        
        if(update) {
            this.fromTime = fromTime;
            fromTimeHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getFromTimeHasBeenModified() {
        return fromTimeHasBeenModified;
    }
    
    public Long getThruTime() {
        return thruTime;
    }
    
    public void setThruTime(Long thruTime)
            throws PersistenceNotNullException {
        checkForNull(thruTime);
        
        boolean update = true;
        
        if(this.thruTime != null) {
            if(this.thruTime.equals(thruTime)) {
                update = false;
            }
        } else if(thruTime == null) {
            update = false;
        }
        
        if(update) {
            this.thruTime = thruTime;
            thruTimeHasBeenModified = true;
            clearHashAndString();
        }
    }
    
    public boolean getThruTimeHasBeenModified() {
        return thruTimeHasBeenModified;
    }
    
}