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

/**
 * UserVisitCampaign.java
 */

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

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

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.model.data.user.server.entity.UserVisit;
import com.echothree.model.data.campaign.server.entity.Campaign;
import com.echothree.model.data.campaign.server.entity.CampaignSource;
import com.echothree.model.data.campaign.server.entity.CampaignMedium;
import com.echothree.model.data.campaign.server.entity.CampaignTerm;
import com.echothree.model.data.campaign.server.entity.CampaignContent;

import com.echothree.model.data.user.server.factory.UserVisitFactory;
import com.echothree.model.data.campaign.server.factory.CampaignFactory;
import com.echothree.model.data.campaign.server.factory.CampaignSourceFactory;
import com.echothree.model.data.campaign.server.factory.CampaignMediumFactory;
import com.echothree.model.data.campaign.server.factory.CampaignTermFactory;
import com.echothree.model.data.campaign.server.factory.CampaignContentFactory;

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

import com.echothree.model.data.campaign.server.value.UserVisitCampaignValue;

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

import com.echothree.util.common.exception.PersistenceException;
import com.echothree.util.common.exception.PersistenceDatabaseException;
import com.echothree.util.common.exception.PersistenceNotNullException;
import com.echothree.util.common.exception.PersistenceReadOnlyException;

import com.echothree.util.common.persistence.BasePK;

import com.echothree.util.common.persistence.type.ByteArray;

import com.echothree.util.server.persistence.BaseEntity;
import com.echothree.util.server.persistence.EntityPermission;
import com.echothree.util.server.persistence.Session;
import com.echothree.util.server.persistence.ThreadSession;

import java.io.Serializable;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

public class UserVisitCampaign
        extends BaseEntity
        implements Serializable {
    
    private UserVisitCampaignPK _pk;
    private UserVisitCampaignValue _value;
    
    /** Creates a new instance of UserVisitCampaign */
    public UserVisitCampaign()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of UserVisitCampaign */
    public UserVisitCampaign(UserVisitCampaignValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public UserVisitCampaignFactory getBaseFactoryInstance() {
        return UserVisitCampaignFactory.getInstance();
    }
    
    @Override
    public boolean hasBeenModified() {
        return _value.hasBeenModified();
    }
    
    @Override
    public int hashCode() {
        return _pk.hashCode();
    }
    
    @Override
    @Nonnull
    public String toString() {
        return _pk.toString();
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(other instanceof UserVisitCampaign that) {
            UserVisitCampaignValue thatValue = that.getUserVisitCampaignValue();
            return _value.equals(thatValue);
        } else {
            return false;
        }
    }
    
    @Override
    public void store()
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().store(this);
    }
    
    @Override
    public void remove()
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().remove(this);
    }
    
    @Nonnull
    public UserVisitCampaignValue getUserVisitCampaignValue() {
        return _value;
    }
    
    public void setUserVisitCampaignValue(@Nonnull UserVisitCampaignValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public UserVisitCampaignPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public UserVisitPK getUserVisitPK() {
        return _value.getUserVisitPK();
    }
    
    @Nonnull
    public UserVisit getUserVisit(EntityPermission entityPermission) {
        return UserVisitFactory.getInstance().getEntityFromPK(entityPermission, getUserVisitPK());
    }
    
    @Nonnull
    public UserVisit getUserVisit() {
        return getUserVisit(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public UserVisit getUserVisitForUpdate() {
        return getUserVisit(EntityPermission.READ_WRITE);
    }
    
    public void setUserVisitPK(@Nonnull UserVisitPK userVisitPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUserVisitPK(userVisitPK);
    }
    
    public void setUserVisit(@Nonnull UserVisit entity) {
        setUserVisitPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getUserVisitPKHasBeenModified() {
        return _value.getUserVisitPKHasBeenModified();
    }
    
    @Nonnull
    public Integer getUserVisitCampaignSequence() {
        return _value.getUserVisitCampaignSequence();
    }
    
    public void setUserVisitCampaignSequence(@Nonnull Integer userVisitCampaignSequence)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUserVisitCampaignSequence(userVisitCampaignSequence);
    }
    
    public boolean getUserVisitCampaignSequenceHasBeenModified() {
        return _value.getUserVisitCampaignSequenceHasBeenModified();
    }
    
    @Nonnull
    public Long getTime() {
        return _value.getTime();
    }
    
    public void setTime(@Nonnull Long time)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setTime(time);
    }
    
    public boolean getTimeHasBeenModified() {
        return _value.getTimeHasBeenModified();
    }
    
    @Nullable
    public CampaignPK getCampaignPK() {
        return _value.getCampaignPK();
    }
    
    @Nullable
    public Campaign getCampaign(EntityPermission entityPermission) {
        CampaignPK pk = getCampaignPK();
        Campaign entity = pk == null? null: CampaignFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Campaign getCampaign() {
        return getCampaign(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Campaign getCampaignForUpdate() {
        return getCampaign(EntityPermission.READ_WRITE);
    }
    
    public void setCampaignPK(@Nullable CampaignPK campaignPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCampaignPK(campaignPK);
    }
    
    public void setCampaign(@Nullable Campaign entity) {
        setCampaignPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCampaignPKHasBeenModified() {
        return _value.getCampaignPKHasBeenModified();
    }
    
    @Nullable
    public CampaignSourcePK getCampaignSourcePK() {
        return _value.getCampaignSourcePK();
    }
    
    @Nullable
    public CampaignSource getCampaignSource(EntityPermission entityPermission) {
        CampaignSourcePK pk = getCampaignSourcePK();
        CampaignSource entity = pk == null? null: CampaignSourceFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public CampaignSource getCampaignSource() {
        return getCampaignSource(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public CampaignSource getCampaignSourceForUpdate() {
        return getCampaignSource(EntityPermission.READ_WRITE);
    }
    
    public void setCampaignSourcePK(@Nullable CampaignSourcePK campaignSourcePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCampaignSourcePK(campaignSourcePK);
    }
    
    public void setCampaignSource(@Nullable CampaignSource entity) {
        setCampaignSourcePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCampaignSourcePKHasBeenModified() {
        return _value.getCampaignSourcePKHasBeenModified();
    }
    
    @Nullable
    public CampaignMediumPK getCampaignMediumPK() {
        return _value.getCampaignMediumPK();
    }
    
    @Nullable
    public CampaignMedium getCampaignMedium(EntityPermission entityPermission) {
        CampaignMediumPK pk = getCampaignMediumPK();
        CampaignMedium entity = pk == null? null: CampaignMediumFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public CampaignMedium getCampaignMedium() {
        return getCampaignMedium(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public CampaignMedium getCampaignMediumForUpdate() {
        return getCampaignMedium(EntityPermission.READ_WRITE);
    }
    
    public void setCampaignMediumPK(@Nullable CampaignMediumPK campaignMediumPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCampaignMediumPK(campaignMediumPK);
    }
    
    public void setCampaignMedium(@Nullable CampaignMedium entity) {
        setCampaignMediumPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCampaignMediumPKHasBeenModified() {
        return _value.getCampaignMediumPKHasBeenModified();
    }
    
    @Nullable
    public CampaignTermPK getCampaignTermPK() {
        return _value.getCampaignTermPK();
    }
    
    @Nullable
    public CampaignTerm getCampaignTerm(EntityPermission entityPermission) {
        CampaignTermPK pk = getCampaignTermPK();
        CampaignTerm entity = pk == null? null: CampaignTermFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public CampaignTerm getCampaignTerm() {
        return getCampaignTerm(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public CampaignTerm getCampaignTermForUpdate() {
        return getCampaignTerm(EntityPermission.READ_WRITE);
    }
    
    public void setCampaignTermPK(@Nullable CampaignTermPK campaignTermPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCampaignTermPK(campaignTermPK);
    }
    
    public void setCampaignTerm(@Nullable CampaignTerm entity) {
        setCampaignTermPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCampaignTermPKHasBeenModified() {
        return _value.getCampaignTermPKHasBeenModified();
    }
    
    @Nullable
    public CampaignContentPK getCampaignContentPK() {
        return _value.getCampaignContentPK();
    }
    
    @Nullable
    public CampaignContent getCampaignContent(EntityPermission entityPermission) {
        CampaignContentPK pk = getCampaignContentPK();
        CampaignContent entity = pk == null? null: CampaignContentFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public CampaignContent getCampaignContent() {
        return getCampaignContent(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public CampaignContent getCampaignContentForUpdate() {
        return getCampaignContent(EntityPermission.READ_WRITE);
    }
    
    public void setCampaignContentPK(@Nullable CampaignContentPK campaignContentPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCampaignContentPK(campaignContentPK);
    }
    
    public void setCampaignContent(@Nullable CampaignContent entity) {
        setCampaignContentPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCampaignContentPKHasBeenModified() {
        return _value.getCampaignContentPKHasBeenModified();
    }
    
    @Nonnull
    public Long getFromTime() {
        return _value.getFromTime();
    }
    
    public void setFromTime(@Nonnull Long fromTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setFromTime(fromTime);
    }
    
    public boolean getFromTimeHasBeenModified() {
        return _value.getFromTimeHasBeenModified();
    }
    
    @Nonnull
    public Long getThruTime() {
        return _value.getThruTime();
    }
    
    public void setThruTime(@Nonnull Long thruTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setThruTime(thruTime);
    }
    
    public boolean getThruTimeHasBeenModified() {
        return _value.getThruTimeHasBeenModified();
    }
    
}