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

/**
 * ForumThreadDetail.java
 */

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

import com.echothree.model.data.forum.common.pk.ForumThreadDetailPK;

import com.echothree.model.data.forum.common.pk.ForumThreadPK;
import com.echothree.model.data.icon.common.pk.IconPK;

import com.echothree.model.data.forum.server.entity.ForumThread;
import com.echothree.model.data.icon.server.entity.Icon;

import com.echothree.model.data.forum.server.factory.ForumThreadFactory;
import com.echothree.model.data.icon.server.factory.IconFactory;

import com.echothree.model.data.forum.common.pk.ForumThreadDetailPK;

import com.echothree.model.data.forum.server.value.ForumThreadDetailValue;

import com.echothree.model.data.forum.server.factory.ForumThreadDetailFactory;

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 ForumThreadDetail
        extends BaseEntity
        implements Serializable {
    
    private ForumThreadDetailPK _pk;
    private ForumThreadDetailValue _value;
    
    /** Creates a new instance of ForumThreadDetail */
    public ForumThreadDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of ForumThreadDetail */
    public ForumThreadDetail(ForumThreadDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public ForumThreadDetailFactory getBaseFactoryInstance() {
        return ForumThreadDetailFactory.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 ForumThreadDetail that) {
            ForumThreadDetailValue thatValue = that.getForumThreadDetailValue();
            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 ForumThreadDetailValue getForumThreadDetailValue() {
        return _value;
    }
    
    public void setForumThreadDetailValue(@Nonnull ForumThreadDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public ForumThreadDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public ForumThreadPK getForumThreadPK() {
        return _value.getForumThreadPK();
    }
    
    @Nonnull
    public ForumThread getForumThread(EntityPermission entityPermission) {
        return ForumThreadFactory.getInstance().getEntityFromPK(entityPermission, getForumThreadPK());
    }
    
    @Nonnull
    public ForumThread getForumThread() {
        return getForumThread(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public ForumThread getForumThreadForUpdate() {
        return getForumThread(EntityPermission.READ_WRITE);
    }
    
    public void setForumThreadPK(@Nonnull ForumThreadPK forumThreadPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setForumThreadPK(forumThreadPK);
    }
    
    public void setForumThread(@Nonnull ForumThread entity) {
        setForumThreadPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getForumThreadPKHasBeenModified() {
        return _value.getForumThreadPKHasBeenModified();
    }
    
    @Nonnull
    public String getForumThreadName() {
        return _value.getForumThreadName();
    }
    
    public void setForumThreadName(@Nonnull String forumThreadName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setForumThreadName(forumThreadName);
    }
    
    public boolean getForumThreadNameHasBeenModified() {
        return _value.getForumThreadNameHasBeenModified();
    }
    
    @Nullable
    public IconPK getIconPK() {
        return _value.getIconPK();
    }
    
    @Nullable
    public Icon getIcon(EntityPermission entityPermission) {
        IconPK pk = getIconPK();
        Icon entity = pk == null? null: IconFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Icon getIcon() {
        return getIcon(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Icon getIconForUpdate() {
        return getIcon(EntityPermission.READ_WRITE);
    }
    
    public void setIconPK(@Nullable IconPK iconPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setIconPK(iconPK);
    }
    
    public void setIcon(@Nullable Icon entity) {
        setIconPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getIconPKHasBeenModified() {
        return _value.getIconPKHasBeenModified();
    }
    
    @Nonnull
    public Long getPostedTime() {
        return _value.getPostedTime();
    }
    
    public void setPostedTime(@Nonnull Long postedTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPostedTime(postedTime);
    }
    
    public boolean getPostedTimeHasBeenModified() {
        return _value.getPostedTimeHasBeenModified();
    }
    
    @Nonnull
    public Integer getSortOrder() {
        return _value.getSortOrder();
    }
    
    public void setSortOrder(@Nonnull Integer sortOrder)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSortOrder(sortOrder);
    }
    
    public boolean getSortOrderHasBeenModified() {
        return _value.getSortOrderHasBeenModified();
    }
    
    @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();
    }
    
}