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

/**
 * UserVisit.java
 */

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

import com.echothree.model.data.user.common.pk.UserVisitPK;

import com.echothree.model.data.user.common.pk.UserVisitGroupPK;
import com.echothree.model.data.user.common.pk.UserKeyPK;
import com.echothree.model.data.party.common.pk.LanguagePK;
import com.echothree.model.data.accounting.common.pk.CurrencyPK;
import com.echothree.model.data.party.common.pk.TimeZonePK;
import com.echothree.model.data.party.common.pk.DateTimeFormatPK;
import com.echothree.model.data.offer.common.pk.OfferUsePK;
import com.echothree.model.data.associate.common.pk.AssociateReferralPK;

import com.echothree.model.data.user.server.entity.UserVisitGroup;
import com.echothree.model.data.user.server.entity.UserKey;
import com.echothree.model.data.party.server.entity.Language;
import com.echothree.model.data.accounting.server.entity.Currency;
import com.echothree.model.data.party.server.entity.TimeZone;
import com.echothree.model.data.party.server.entity.DateTimeFormat;
import com.echothree.model.data.offer.server.entity.OfferUse;
import com.echothree.model.data.associate.server.entity.AssociateReferral;

import com.echothree.model.data.user.server.factory.UserVisitGroupFactory;
import com.echothree.model.data.user.server.factory.UserKeyFactory;
import com.echothree.model.data.party.server.factory.LanguageFactory;
import com.echothree.model.data.accounting.server.factory.CurrencyFactory;
import com.echothree.model.data.party.server.factory.TimeZoneFactory;
import com.echothree.model.data.party.server.factory.DateTimeFormatFactory;
import com.echothree.model.data.offer.server.factory.OfferUseFactory;
import com.echothree.model.data.associate.server.factory.AssociateReferralFactory;

import com.echothree.model.data.user.common.pk.UserVisitPK;

import com.echothree.model.data.user.server.value.UserVisitValue;

import com.echothree.model.data.user.server.factory.UserVisitFactory;

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 UserVisit
        extends BaseEntity
        implements Serializable {
    
    private UserVisitPK _pk;
    private UserVisitValue _value;
    
    /** Creates a new instance of UserVisit */
    public UserVisit()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of UserVisit */
    public UserVisit(UserVisitValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public UserVisitFactory getBaseFactoryInstance() {
        return UserVisitFactory.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 UserVisit that) {
            UserVisitValue thatValue = that.getUserVisitValue();
            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 UserVisitValue getUserVisitValue() {
        return _value;
    }
    
    public void setUserVisitValue(@Nonnull UserVisitValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public UserVisitPK getPrimaryKey() {
        return _pk;
    }
    
    @Nullable
    public UserVisitGroupPK getUserVisitGroupPK() {
        return _value.getUserVisitGroupPK();
    }
    
    @Nullable
    public UserVisitGroup getUserVisitGroup(EntityPermission entityPermission) {
        UserVisitGroupPK pk = getUserVisitGroupPK();
        UserVisitGroup entity = pk == null? null: UserVisitGroupFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public UserVisitGroup getUserVisitGroup() {
        return getUserVisitGroup(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public UserVisitGroup getUserVisitGroupForUpdate() {
        return getUserVisitGroup(EntityPermission.READ_WRITE);
    }
    
    public void setUserVisitGroupPK(@Nullable UserVisitGroupPK userVisitGroupPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUserVisitGroupPK(userVisitGroupPK);
    }
    
    public void setUserVisitGroup(@Nullable UserVisitGroup entity) {
        setUserVisitGroupPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getUserVisitGroupPKHasBeenModified() {
        return _value.getUserVisitGroupPKHasBeenModified();
    }
    
    @Nullable
    public UserKeyPK getUserKeyPK() {
        return _value.getUserKeyPK();
    }
    
    @Nullable
    public UserKey getUserKey(EntityPermission entityPermission) {
        UserKeyPK pk = getUserKeyPK();
        UserKey entity = pk == null? null: UserKeyFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public UserKey getUserKey() {
        return getUserKey(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public UserKey getUserKeyForUpdate() {
        return getUserKey(EntityPermission.READ_WRITE);
    }
    
    public void setUserKeyPK(@Nullable UserKeyPK userKeyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUserKeyPK(userKeyPK);
    }
    
    public void setUserKey(@Nullable UserKey entity) {
        setUserKeyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getUserKeyPKHasBeenModified() {
        return _value.getUserKeyPKHasBeenModified();
    }
    
    @Nullable
    public LanguagePK getPreferredLanguagePK() {
        return _value.getPreferredLanguagePK();
    }
    
    @Nullable
    public Language getPreferredLanguage(EntityPermission entityPermission) {
        LanguagePK pk = getPreferredLanguagePK();
        Language entity = pk == null? null: LanguageFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Language getPreferredLanguage() {
        return getPreferredLanguage(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Language getPreferredLanguageForUpdate() {
        return getPreferredLanguage(EntityPermission.READ_WRITE);
    }
    
    public void setPreferredLanguagePK(@Nullable LanguagePK preferredLanguagePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPreferredLanguagePK(preferredLanguagePK);
    }
    
    public void setPreferredLanguage(@Nullable Language entity) {
        setPreferredLanguagePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPreferredLanguagePKHasBeenModified() {
        return _value.getPreferredLanguagePKHasBeenModified();
    }
    
    @Nullable
    public CurrencyPK getPreferredCurrencyPK() {
        return _value.getPreferredCurrencyPK();
    }
    
    @Nullable
    public Currency getPreferredCurrency(EntityPermission entityPermission) {
        CurrencyPK pk = getPreferredCurrencyPK();
        Currency entity = pk == null? null: CurrencyFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Currency getPreferredCurrency() {
        return getPreferredCurrency(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Currency getPreferredCurrencyForUpdate() {
        return getPreferredCurrency(EntityPermission.READ_WRITE);
    }
    
    public void setPreferredCurrencyPK(@Nullable CurrencyPK preferredCurrencyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPreferredCurrencyPK(preferredCurrencyPK);
    }
    
    public void setPreferredCurrency(@Nullable Currency entity) {
        setPreferredCurrencyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPreferredCurrencyPKHasBeenModified() {
        return _value.getPreferredCurrencyPKHasBeenModified();
    }
    
    @Nullable
    public TimeZonePK getPreferredTimeZonePK() {
        return _value.getPreferredTimeZonePK();
    }
    
    @Nullable
    public TimeZone getPreferredTimeZone(EntityPermission entityPermission) {
        TimeZonePK pk = getPreferredTimeZonePK();
        TimeZone entity = pk == null? null: TimeZoneFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public TimeZone getPreferredTimeZone() {
        return getPreferredTimeZone(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public TimeZone getPreferredTimeZoneForUpdate() {
        return getPreferredTimeZone(EntityPermission.READ_WRITE);
    }
    
    public void setPreferredTimeZonePK(@Nullable TimeZonePK preferredTimeZonePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPreferredTimeZonePK(preferredTimeZonePK);
    }
    
    public void setPreferredTimeZone(@Nullable TimeZone entity) {
        setPreferredTimeZonePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPreferredTimeZonePKHasBeenModified() {
        return _value.getPreferredTimeZonePKHasBeenModified();
    }
    
    @Nullable
    public DateTimeFormatPK getPreferredDateTimeFormatPK() {
        return _value.getPreferredDateTimeFormatPK();
    }
    
    @Nullable
    public DateTimeFormat getPreferredDateTimeFormat(EntityPermission entityPermission) {
        DateTimeFormatPK pk = getPreferredDateTimeFormatPK();
        DateTimeFormat entity = pk == null? null: DateTimeFormatFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public DateTimeFormat getPreferredDateTimeFormat() {
        return getPreferredDateTimeFormat(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public DateTimeFormat getPreferredDateTimeFormatForUpdate() {
        return getPreferredDateTimeFormat(EntityPermission.READ_WRITE);
    }
    
    public void setPreferredDateTimeFormatPK(@Nullable DateTimeFormatPK preferredDateTimeFormatPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPreferredDateTimeFormatPK(preferredDateTimeFormatPK);
    }
    
    public void setPreferredDateTimeFormat(@Nullable DateTimeFormat entity) {
        setPreferredDateTimeFormatPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPreferredDateTimeFormatPKHasBeenModified() {
        return _value.getPreferredDateTimeFormatPKHasBeenModified();
    }
    
    @Nonnull
    public Long getLastCommandTime() {
        return _value.getLastCommandTime();
    }
    
    public void setLastCommandTime(@Nonnull Long lastCommandTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setLastCommandTime(lastCommandTime);
    }
    
    public boolean getLastCommandTimeHasBeenModified() {
        return _value.getLastCommandTimeHasBeenModified();
    }
    
    @Nullable
    public OfferUsePK getOfferUsePK() {
        return _value.getOfferUsePK();
    }
    
    @Nullable
    public OfferUse getOfferUse(EntityPermission entityPermission) {
        OfferUsePK pk = getOfferUsePK();
        OfferUse entity = pk == null? null: OfferUseFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public OfferUse getOfferUse() {
        return getOfferUse(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public OfferUse getOfferUseForUpdate() {
        return getOfferUse(EntityPermission.READ_WRITE);
    }
    
    public void setOfferUsePK(@Nullable OfferUsePK offerUsePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setOfferUsePK(offerUsePK);
    }
    
    public void setOfferUse(@Nullable OfferUse entity) {
        setOfferUsePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getOfferUsePKHasBeenModified() {
        return _value.getOfferUsePKHasBeenModified();
    }
    
    @Nullable
    public AssociateReferralPK getAssociateReferralPK() {
        return _value.getAssociateReferralPK();
    }
    
    @Nullable
    public AssociateReferral getAssociateReferral(EntityPermission entityPermission) {
        AssociateReferralPK pk = getAssociateReferralPK();
        AssociateReferral entity = pk == null? null: AssociateReferralFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public AssociateReferral getAssociateReferral() {
        return getAssociateReferral(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public AssociateReferral getAssociateReferralForUpdate() {
        return getAssociateReferral(EntityPermission.READ_WRITE);
    }
    
    public void setAssociateReferralPK(@Nullable AssociateReferralPK associateReferralPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAssociateReferralPK(associateReferralPK);
    }
    
    public void setAssociateReferral(@Nullable AssociateReferral entity) {
        setAssociateReferralPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getAssociateReferralPKHasBeenModified() {
        return _value.getAssociateReferralPKHasBeenModified();
    }
    
    @Nullable
    public Long getRetainUntilTime() {
        return _value.getRetainUntilTime();
    }
    
    public void setRetainUntilTime(@Nullable Long retainUntilTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRetainUntilTime(retainUntilTime);
    }
    
    public boolean getRetainUntilTimeHasBeenModified() {
        return _value.getRetainUntilTimeHasBeenModified();
    }
    
    @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();
    }
    
}