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

/**
 * AssociateReferralDetail.java
 */

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

import com.echothree.model.data.associate.common.pk.AssociateReferralDetailPK;

import com.echothree.model.data.associate.common.pk.AssociateReferralPK;
import com.echothree.model.data.associate.common.pk.AssociatePK;
import com.echothree.model.data.associate.common.pk.AssociatePartyContactMechanismPK;
import com.echothree.model.data.core.common.pk.EntityInstancePK;

import com.echothree.model.data.associate.server.entity.AssociateReferral;
import com.echothree.model.data.associate.server.entity.Associate;
import com.echothree.model.data.associate.server.entity.AssociatePartyContactMechanism;
import com.echothree.model.data.core.server.entity.EntityInstance;

import com.echothree.model.data.associate.server.factory.AssociateReferralFactory;
import com.echothree.model.data.associate.server.factory.AssociateFactory;
import com.echothree.model.data.associate.server.factory.AssociatePartyContactMechanismFactory;
import com.echothree.model.data.core.server.factory.EntityInstanceFactory;

import com.echothree.model.data.associate.common.pk.AssociateReferralDetailPK;

import com.echothree.model.data.associate.server.value.AssociateReferralDetailValue;

import com.echothree.model.data.associate.server.factory.AssociateReferralDetailFactory;

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 AssociateReferralDetail
        extends BaseEntity
        implements Serializable {
    
    private AssociateReferralDetailPK _pk;
    private AssociateReferralDetailValue _value;
    
    /** Creates a new instance of AssociateReferralDetail */
    public AssociateReferralDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of AssociateReferralDetail */
    public AssociateReferralDetail(AssociateReferralDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public AssociateReferralDetailFactory getBaseFactoryInstance() {
        return AssociateReferralDetailFactory.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 AssociateReferralDetail that) {
            AssociateReferralDetailValue thatValue = that.getAssociateReferralDetailValue();
            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 AssociateReferralDetailValue getAssociateReferralDetailValue() {
        return _value;
    }
    
    public void setAssociateReferralDetailValue(@Nonnull AssociateReferralDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public AssociateReferralDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nullable
    public AssociateReferralPK getAssociateReferralPK() {
        return _value.getAssociateReferralPK();
    }
    
    @Nullable
    public AssociateReferral getAssociateReferral(EntityPermission entityPermission) {
        AssociateReferralPK pk = getAssociateReferralPK();
        AssociateReferral entity = pk == null? null: AssociateReferralFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public AssociateReferral getAssociateReferral() {
        return getAssociateReferral(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public AssociateReferral getAssociateReferralForUpdate() {
        return getAssociateReferral(EntityPermission.READ_WRITE);
    }
    
    public void setAssociateReferralPK(@Nullable AssociateReferralPK associateReferralPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAssociateReferralPK(associateReferralPK);
    }
    
    public void setAssociateReferral(@Nullable AssociateReferral entity) {
        setAssociateReferralPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getAssociateReferralPKHasBeenModified() {
        return _value.getAssociateReferralPKHasBeenModified();
    }
    
    @Nonnull
    public String getAssociateReferralName() {
        return _value.getAssociateReferralName();
    }
    
    public void setAssociateReferralName(@Nonnull String associateReferralName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAssociateReferralName(associateReferralName);
    }
    
    public boolean getAssociateReferralNameHasBeenModified() {
        return _value.getAssociateReferralNameHasBeenModified();
    }
    
    @Nonnull
    public AssociatePK getAssociatePK() {
        return _value.getAssociatePK();
    }
    
    @Nonnull
    public Associate getAssociate(EntityPermission entityPermission) {
        return AssociateFactory.getInstance().getEntityFromPK(entityPermission, getAssociatePK());
    }
    
    @Nonnull
    public Associate getAssociate() {
        return getAssociate(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Associate getAssociateForUpdate() {
        return getAssociate(EntityPermission.READ_WRITE);
    }
    
    public void setAssociatePK(@Nonnull AssociatePK associatePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAssociatePK(associatePK);
    }
    
    public void setAssociate(@Nonnull Associate entity) {
        setAssociatePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getAssociatePKHasBeenModified() {
        return _value.getAssociatePKHasBeenModified();
    }
    
    @Nullable
    public AssociatePartyContactMechanismPK getAssociatePartyContactMechanismPK() {
        return _value.getAssociatePartyContactMechanismPK();
    }
    
    @Nullable
    public AssociatePartyContactMechanism getAssociatePartyContactMechanism(EntityPermission entityPermission) {
        AssociatePartyContactMechanismPK pk = getAssociatePartyContactMechanismPK();
        AssociatePartyContactMechanism entity = pk == null? null: AssociatePartyContactMechanismFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public AssociatePartyContactMechanism getAssociatePartyContactMechanism() {
        return getAssociatePartyContactMechanism(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public AssociatePartyContactMechanism getAssociatePartyContactMechanismForUpdate() {
        return getAssociatePartyContactMechanism(EntityPermission.READ_WRITE);
    }
    
    public void setAssociatePartyContactMechanismPK(@Nullable AssociatePartyContactMechanismPK associatePartyContactMechanismPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAssociatePartyContactMechanismPK(associatePartyContactMechanismPK);
    }
    
    public void setAssociatePartyContactMechanism(@Nullable AssociatePartyContactMechanism entity) {
        setAssociatePartyContactMechanismPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getAssociatePartyContactMechanismPKHasBeenModified() {
        return _value.getAssociatePartyContactMechanismPKHasBeenModified();
    }
    
    @Nullable
    public EntityInstancePK getTargetEntityInstancePK() {
        return _value.getTargetEntityInstancePK();
    }
    
    @Nullable
    public EntityInstance getTargetEntityInstance(EntityPermission entityPermission) {
        EntityInstancePK pk = getTargetEntityInstancePK();
        EntityInstance entity = pk == null? null: EntityInstanceFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public EntityInstance getTargetEntityInstance() {
        return getTargetEntityInstance(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public EntityInstance getTargetEntityInstanceForUpdate() {
        return getTargetEntityInstance(EntityPermission.READ_WRITE);
    }
    
    public void setTargetEntityInstancePK(@Nullable EntityInstancePK targetEntityInstancePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setTargetEntityInstancePK(targetEntityInstancePK);
    }
    
    public void setTargetEntityInstance(@Nullable EntityInstance entity) {
        setTargetEntityInstancePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getTargetEntityInstancePKHasBeenModified() {
        return _value.getTargetEntityInstancePKHasBeenModified();
    }
    
    @Nonnull
    public Long getAssociateReferralTime() {
        return _value.getAssociateReferralTime();
    }
    
    public void setAssociateReferralTime(@Nonnull Long associateReferralTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAssociateReferralTime(associateReferralTime);
    }
    
    public boolean getAssociateReferralTimeHasBeenModified() {
        return _value.getAssociateReferralTimeHasBeenModified();
    }
    
    @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();
    }
    
}