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

/**
 * UserSession.java
 */

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

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

import com.echothree.model.data.user.common.pk.UserVisitPK;
import com.echothree.model.data.party.common.pk.PartyPK;
import com.echothree.model.data.party.common.pk.PartyRelationshipPK;

import com.echothree.model.data.user.server.entity.UserVisit;
import com.echothree.model.data.party.server.entity.Party;
import com.echothree.model.data.party.server.entity.PartyRelationship;

import com.echothree.model.data.user.server.factory.UserVisitFactory;
import com.echothree.model.data.party.server.factory.PartyFactory;
import com.echothree.model.data.party.server.factory.PartyRelationshipFactory;

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

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

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

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 UserSession
        extends BaseEntity
        implements Serializable {
    
    private UserSessionPK _pk;
    private UserSessionValue _value;
    
    /** Creates a new instance of UserSession */
    public UserSession()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of UserSession */
    public UserSession(UserSessionValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public UserSessionFactory getBaseFactoryInstance() {
        return UserSessionFactory.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 UserSession that) {
            UserSessionValue thatValue = that.getUserSessionValue();
            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 UserSessionValue getUserSessionValue() {
        return _value;
    }
    
    public void setUserSessionValue(@Nonnull UserSessionValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public UserSessionPK 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 PartyPK getPartyPK() {
        return _value.getPartyPK();
    }
    
    @Nonnull
    public Party getParty(EntityPermission entityPermission) {
        return PartyFactory.getInstance().getEntityFromPK(entityPermission, getPartyPK());
    }
    
    @Nonnull
    public Party getParty() {
        return getParty(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Party getPartyForUpdate() {
        return getParty(EntityPermission.READ_WRITE);
    }
    
    public void setPartyPK(@Nonnull PartyPK partyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPartyPK(partyPK);
    }
    
    public void setParty(@Nonnull Party entity) {
        setPartyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPartyPKHasBeenModified() {
        return _value.getPartyPKHasBeenModified();
    }
    
    @Nullable
    public PartyRelationshipPK getPartyRelationshipPK() {
        return _value.getPartyRelationshipPK();
    }
    
    @Nullable
    public PartyRelationship getPartyRelationship(EntityPermission entityPermission) {
        PartyRelationshipPK pk = getPartyRelationshipPK();
        PartyRelationship entity = pk == null? null: PartyRelationshipFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public PartyRelationship getPartyRelationship() {
        return getPartyRelationship(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public PartyRelationship getPartyRelationshipForUpdate() {
        return getPartyRelationship(EntityPermission.READ_WRITE);
    }
    
    public void setPartyRelationshipPK(@Nullable PartyRelationshipPK partyRelationshipPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPartyRelationshipPK(partyRelationshipPK);
    }
    
    public void setPartyRelationship(@Nullable PartyRelationship entity) {
        setPartyRelationshipPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPartyRelationshipPKHasBeenModified() {
        return _value.getPartyRelationshipPKHasBeenModified();
    }
    
    @Nullable
    public Long getIdentityVerifiedTime() {
        return _value.getIdentityVerifiedTime();
    }
    
    public void setIdentityVerifiedTime(@Nullable Long identityVerifiedTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setIdentityVerifiedTime(identityVerifiedTime);
    }
    
    public boolean getIdentityVerifiedTimeHasBeenModified() {
        return _value.getIdentityVerifiedTimeHasBeenModified();
    }
    
    @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();
    }
    
}