// --------------------------------------------------------------------------------
// Copyright 2002-2025 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
// --------------------------------------------------------------------------------

/**
 * UserLoginPasswordString.java
 */

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

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

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

import com.echothree.model.data.user.server.entity.UserLoginPassword;

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

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

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

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

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;

public class UserLoginPasswordString
        extends BaseEntity
        implements Serializable {
    
    private UserLoginPasswordStringPK _pk;
    private UserLoginPasswordStringValue _value;
    
    /** Creates a new instance of UserLoginPasswordString */
    public UserLoginPasswordString()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of UserLoginPasswordString */
    public UserLoginPasswordString(UserLoginPasswordStringValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    public UserLoginPasswordStringFactory getBaseFactoryInstance() {
        return UserLoginPasswordStringFactory.getInstance();
    }
    
    @Override
    public boolean hasBeenModified() {
        return _value.hasBeenModified();
    }
    
    @Override
    public int hashCode() {
        return _pk.hashCode();
    }
    
    @Override
    public String toString() {
        return _pk.toString();
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(other instanceof UserLoginPasswordString that) {
            UserLoginPasswordStringValue thatValue = that.getUserLoginPasswordStringValue();
            return _value.equals(thatValue);
        } else {
            return false;
        }
    }
    
    @Override
    public void store(Session session)
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().store(session, this);
    }
    
    @Override
    public void remove(Session session)
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().remove(session, this);
    }
    
    @Override
    public void remove()
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
    }
    
    public UserLoginPasswordStringValue getUserLoginPasswordStringValue() {
        return _value;
    }
    
    public void setUserLoginPasswordStringValue(UserLoginPasswordStringValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    public UserLoginPasswordStringPK getPrimaryKey() {
        return _pk;
    }
    
    public UserLoginPasswordPK getUserLoginPasswordPK() {
        return _value.getUserLoginPasswordPK();
    }
    
    public UserLoginPassword getUserLoginPassword(Session session, EntityPermission entityPermission) {
        return UserLoginPasswordFactory.getInstance().getEntityFromPK(session, entityPermission, getUserLoginPasswordPK());
    }
    
    public UserLoginPassword getUserLoginPassword(EntityPermission entityPermission) {
        return getUserLoginPassword(ThreadSession.currentSession(), entityPermission);
    }
    
    public UserLoginPassword getUserLoginPassword(Session session) {
        return getUserLoginPassword(session, EntityPermission.READ_ONLY);
    }
    
    public UserLoginPassword getUserLoginPassword() {
        return getUserLoginPassword(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
    }
    
    public UserLoginPassword getUserLoginPasswordForUpdate(Session session) {
        return getUserLoginPassword(session, EntityPermission.READ_WRITE);
    }
    
    public UserLoginPassword getUserLoginPasswordForUpdate() {
        return getUserLoginPassword(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
    }
    
    public void setUserLoginPasswordPK(UserLoginPasswordPK userLoginPasswordPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUserLoginPasswordPK(userLoginPasswordPK);
    }
    
    public void setUserLoginPassword(UserLoginPassword entity) {
        setUserLoginPasswordPK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getUserLoginPasswordPKHasBeenModified() {
        return _value.getUserLoginPasswordPKHasBeenModified();
    }
    
    public String getSalt() {
        return _value.getSalt();
    }
    
    public void setSalt(String salt)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSalt(salt);
    }
    
    public boolean getSaltHasBeenModified() {
        return _value.getSaltHasBeenModified();
    }
    
    public String getPassword() {
        return _value.getPassword();
    }
    
    public void setPassword(String password)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPassword(password);
    }
    
    public boolean getPasswordHasBeenModified() {
        return _value.getPasswordHasBeenModified();
    }
    
    public Long getChangedTime() {
        return _value.getChangedTime();
    }
    
    public void setChangedTime(Long changedTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setChangedTime(changedTime);
    }
    
    public boolean getChangedTimeHasBeenModified() {
        return _value.getChangedTimeHasBeenModified();
    }
    
    public Boolean getWasReset() {
        return _value.getWasReset();
    }
    
    public void setWasReset(Boolean wasReset)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setWasReset(wasReset);
    }
    
    public boolean getWasResetHasBeenModified() {
        return _value.getWasResetHasBeenModified();
    }
    
    public Long getFromTime() {
        return _value.getFromTime();
    }
    
    public void setFromTime(Long fromTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setFromTime(fromTime);
    }
    
    public boolean getFromTimeHasBeenModified() {
        return _value.getFromTimeHasBeenModified();
    }
    
    public Long getThruTime() {
        return _value.getThruTime();
    }
    
    public void setThruTime(Long thruTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setThruTime(thruTime);
    }
    
    public boolean getThruTimeHasBeenModified() {
        return _value.getThruTimeHasBeenModified();
    }
    
}