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

/**
 * Link.java
 */

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

import com.echothree.model.data.core.common.pk.LinkPK;

import com.echothree.model.data.core.common.pk.LinkTypePK;
import com.echothree.model.data.core.common.pk.EntityInstancePK;

import com.echothree.model.data.core.server.entity.LinkType;
import com.echothree.model.data.core.server.entity.EntityInstance;

import com.echothree.model.data.core.server.factory.LinkTypeFactory;
import com.echothree.model.data.core.server.factory.EntityInstanceFactory;

import com.echothree.model.data.core.common.pk.LinkPK;

import com.echothree.model.data.core.server.value.LinkValue;

import com.echothree.model.data.core.server.factory.LinkFactory;

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 Link
        extends BaseEntity
        implements Serializable {
    
    private LinkPK _pk;
    private LinkValue _value;
    
    /** Creates a new instance of Link */
    public Link()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of Link */
    public Link(LinkValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public LinkFactory getBaseFactoryInstance() {
        return LinkFactory.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 Link that) {
            LinkValue thatValue = that.getLinkValue();
            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 LinkValue getLinkValue() {
        return _value;
    }
    
    public void setLinkValue(@Nonnull LinkValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public LinkPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public LinkTypePK getLinkTypePK() {
        return _value.getLinkTypePK();
    }
    
    @Nonnull
    public LinkType getLinkType(EntityPermission entityPermission) {
        return LinkTypeFactory.getInstance().getEntityFromPK(entityPermission, getLinkTypePK());
    }
    
    @Nonnull
    public LinkType getLinkType() {
        return getLinkType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public LinkType getLinkTypeForUpdate() {
        return getLinkType(EntityPermission.READ_WRITE);
    }
    
    public void setLinkTypePK(@Nonnull LinkTypePK linkTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setLinkTypePK(linkTypePK);
    }
    
    public void setLinkType(@Nonnull LinkType entity) {
        setLinkTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getLinkTypePKHasBeenModified() {
        return _value.getLinkTypePKHasBeenModified();
    }
    
    @Nonnull
    public EntityInstancePK getSourceEntityInstancePK() {
        return _value.getSourceEntityInstancePK();
    }
    
    @Nonnull
    public EntityInstance getSourceEntityInstance(EntityPermission entityPermission) {
        return EntityInstanceFactory.getInstance().getEntityFromPK(entityPermission, getSourceEntityInstancePK());
    }
    
    @Nonnull
    public EntityInstance getSourceEntityInstance() {
        return getSourceEntityInstance(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public EntityInstance getSourceEntityInstanceForUpdate() {
        return getSourceEntityInstance(EntityPermission.READ_WRITE);
    }
    
    public void setSourceEntityInstancePK(@Nonnull EntityInstancePK sourceEntityInstancePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSourceEntityInstancePK(sourceEntityInstancePK);
    }
    
    public void setSourceEntityInstance(@Nonnull EntityInstance entity) {
        setSourceEntityInstancePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getSourceEntityInstancePKHasBeenModified() {
        return _value.getSourceEntityInstancePKHasBeenModified();
    }
    
    @Nonnull
    public EntityInstancePK getTargetEntityInstancePK() {
        return _value.getTargetEntityInstancePK();
    }
    
    @Nonnull
    public EntityInstance getTargetEntityInstance(EntityPermission entityPermission) {
        return EntityInstanceFactory.getInstance().getEntityFromPK(entityPermission, getTargetEntityInstancePK());
    }
    
    @Nonnull
    public EntityInstance getTargetEntityInstance() {
        return getTargetEntityInstance(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public EntityInstance getTargetEntityInstanceForUpdate() {
        return getTargetEntityInstance(EntityPermission.READ_WRITE);
    }
    
    public void setTargetEntityInstancePK(@Nonnull EntityInstancePK targetEntityInstancePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setTargetEntityInstancePK(targetEntityInstancePK);
    }
    
    public void setTargetEntityInstance(@Nonnull EntityInstance entity) {
        setTargetEntityInstancePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getTargetEntityInstancePKHasBeenModified() {
        return _value.getTargetEntityInstancePKHasBeenModified();
    }
    
    @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();
    }
    
}