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

/**
 * UserKeyDetail.java
 */

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

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

import com.echothree.model.data.user.common.pk.UserKeyPK;
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.UserKey;
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.UserKeyFactory;
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.UserKeyDetailPK;

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

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

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 UserKeyDetail
        extends BaseEntity
        implements Serializable {
    
    private UserKeyDetailPK _pk;
    private UserKeyDetailValue _value;
    
    /** Creates a new instance of UserKeyDetail */
    public UserKeyDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of UserKeyDetail */
    public UserKeyDetail(UserKeyDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public UserKeyDetailFactory getBaseFactoryInstance() {
        return UserKeyDetailFactory.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 UserKeyDetail that) {
            UserKeyDetailValue thatValue = that.getUserKeyDetailValue();
            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 UserKeyDetailValue getUserKeyDetailValue() {
        return _value;
    }
    
    public void setUserKeyDetailValue(@Nonnull UserKeyDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public UserKeyDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public UserKeyPK getUserKeyPK() {
        return _value.getUserKeyPK();
    }
    
    @Nonnull
    public UserKey getUserKey(EntityPermission entityPermission) {
        return UserKeyFactory.getInstance().getEntityFromPK(entityPermission, getUserKeyPK());
    }
    
    @Nonnull
    public UserKey getUserKey() {
        return getUserKey(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public UserKey getUserKeyForUpdate() {
        return getUserKey(EntityPermission.READ_WRITE);
    }
    
    public void setUserKeyPK(@Nonnull UserKeyPK userKeyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUserKeyPK(userKeyPK);
    }
    
    public void setUserKey(@Nonnull UserKey entity) {
        setUserKeyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getUserKeyPKHasBeenModified() {
        return _value.getUserKeyPKHasBeenModified();
    }
    
    @Nonnull
    public String getUserKeyName() {
        return _value.getUserKeyName();
    }
    
    public void setUserKeyName(@Nonnull String userKeyName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUserKeyName(userKeyName);
    }
    
    public boolean getUserKeyNameHasBeenModified() {
        return _value.getUserKeyNameHasBeenModified();
    }
    
    @Nullable
    public PartyPK getPartyPK() {
        return _value.getPartyPK();
    }
    
    @Nullable
    public Party getParty(EntityPermission entityPermission) {
        PartyPK pk = getPartyPK();
        Party entity = pk == null? null: PartyFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Party getParty() {
        return getParty(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Party getPartyForUpdate() {
        return getParty(EntityPermission.READ_WRITE);
    }
    
    public void setPartyPK(@Nullable PartyPK partyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPartyPK(partyPK);
    }
    
    public void setParty(@Nullable 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();
    }
    
    @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();
    }
    
}