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

/**
 * UserVisitTrack.java
 */

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

import com.echothree.model.data.track.common.pk.UserVisitTrackPK;

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

import com.echothree.model.data.user.server.entity.UserVisit;
import com.echothree.model.data.track.server.entity.Track;

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

import com.echothree.model.data.track.common.pk.UserVisitTrackPK;

import com.echothree.model.data.track.server.value.UserVisitTrackValue;

import com.echothree.model.data.track.server.factory.UserVisitTrackFactory;

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 UserVisitTrack
        extends BaseEntity
        implements Serializable {
    
    private UserVisitTrackPK _pk;
    private UserVisitTrackValue _value;
    
    /** Creates a new instance of UserVisitTrack */
    public UserVisitTrack()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of UserVisitTrack */
    public UserVisitTrack(UserVisitTrackValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public UserVisitTrackFactory getBaseFactoryInstance() {
        return UserVisitTrackFactory.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 UserVisitTrack that) {
            UserVisitTrackValue thatValue = that.getUserVisitTrackValue();
            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 UserVisitTrackValue getUserVisitTrackValue() {
        return _value;
    }
    
    public void setUserVisitTrackValue(@Nonnull UserVisitTrackValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public UserVisitTrackPK 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 getUserVisitTrackSequence() {
        return _value.getUserVisitTrackSequence();
    }
    
    public void setUserVisitTrackSequence(@Nonnull Integer userVisitTrackSequence)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUserVisitTrackSequence(userVisitTrackSequence);
    }
    
    public boolean getUserVisitTrackSequenceHasBeenModified() {
        return _value.getUserVisitTrackSequenceHasBeenModified();
    }
    
    @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 TrackPK getTrackPK() {
        return _value.getTrackPK();
    }
    
    @Nullable
    public Track getTrack(EntityPermission entityPermission) {
        TrackPK pk = getTrackPK();
        Track entity = pk == null? null: TrackFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Track getTrack() {
        return getTrack(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Track getTrackForUpdate() {
        return getTrack(EntityPermission.READ_WRITE);
    }
    
    public void setTrackPK(@Nullable TrackPK trackPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setTrackPK(trackPK);
    }
    
    public void setTrack(@Nullable Track entity) {
        setTrackPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getTrackPKHasBeenModified() {
        return _value.getTrackPKHasBeenModified();
    }
    
    @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();
    }
    
}