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

/**
 * UserLoginStatus.java
 */

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

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

import com.echothree.model.data.party.common.pk.PartyPK;

import com.echothree.model.data.party.server.entity.Party;

import com.echothree.model.data.party.server.factory.PartyFactory;

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

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

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

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 UserLoginStatus
        extends BaseEntity
        implements Serializable {
    
    private UserLoginStatusPK _pk;
    private UserLoginStatusValue _value;
    
    /** Creates a new instance of UserLoginStatus */
    public UserLoginStatus()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of UserLoginStatus */
    public UserLoginStatus(UserLoginStatusValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public UserLoginStatusFactory getBaseFactoryInstance() {
        return UserLoginStatusFactory.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 UserLoginStatus that) {
            UserLoginStatusValue thatValue = that.getUserLoginStatusValue();
            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 UserLoginStatusValue getUserLoginStatusValue() {
        return _value;
    }
    
    public void setUserLoginStatusValue(@Nonnull UserLoginStatusValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public UserLoginStatusPK getPrimaryKey() {
        return _pk;
    }
    
    @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 Long getLastLoginTime() {
        return _value.getLastLoginTime();
    }
    
    public void setLastLoginTime(@Nullable Long lastLoginTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setLastLoginTime(lastLoginTime);
    }
    
    public boolean getLastLoginTimeHasBeenModified() {
        return _value.getLastLoginTimeHasBeenModified();
    }
    
    @Nonnull
    public Integer getFailureCount() {
        return _value.getFailureCount();
    }
    
    public void setFailureCount(@Nonnull Integer failureCount)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setFailureCount(failureCount);
    }
    
    public boolean getFailureCountHasBeenModified() {
        return _value.getFailureCountHasBeenModified();
    }
    
    @Nullable
    public Long getFirstFailureTime() {
        return _value.getFirstFailureTime();
    }
    
    public void setFirstFailureTime(@Nullable Long firstFailureTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setFirstFailureTime(firstFailureTime);
    }
    
    public boolean getFirstFailureTimeHasBeenModified() {
        return _value.getFirstFailureTimeHasBeenModified();
    }
    
    @Nullable
    public Long getLastFailureTime() {
        return _value.getLastFailureTime();
    }
    
    public void setLastFailureTime(@Nullable Long lastFailureTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setLastFailureTime(lastFailureTime);
    }
    
    public boolean getLastFailureTimeHasBeenModified() {
        return _value.getLastFailureTimeHasBeenModified();
    }
    
    @Nonnull
    public Integer getExpiredCount() {
        return _value.getExpiredCount();
    }
    
    public void setExpiredCount(@Nonnull Integer expiredCount)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setExpiredCount(expiredCount);
    }
    
    public boolean getExpiredCountHasBeenModified() {
        return _value.getExpiredCountHasBeenModified();
    }
    
    @Nonnull
    public Boolean getForceChange() {
        return _value.getForceChange();
    }
    
    public void setForceChange(@Nonnull Boolean forceChange)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setForceChange(forceChange);
    }
    
    public boolean getForceChangeHasBeenModified() {
        return _value.getForceChangeHasBeenModified();
    }
    
}