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

/**
 * ForumDetail.java
 */

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

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

import com.echothree.model.data.forum.common.pk.ForumPK;
import com.echothree.model.data.forum.common.pk.ForumTypePK;
import com.echothree.model.data.icon.common.pk.IconPK;
import com.echothree.model.data.sequence.common.pk.SequencePK;

import com.echothree.model.data.forum.server.entity.Forum;
import com.echothree.model.data.forum.server.entity.ForumType;
import com.echothree.model.data.icon.server.entity.Icon;
import com.echothree.model.data.sequence.server.entity.Sequence;

import com.echothree.model.data.forum.server.factory.ForumFactory;
import com.echothree.model.data.forum.server.factory.ForumTypeFactory;
import com.echothree.model.data.icon.server.factory.IconFactory;
import com.echothree.model.data.sequence.server.factory.SequenceFactory;

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

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

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

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 ForumDetail
        extends BaseEntity
        implements Serializable {
    
    private ForumDetailPK _pk;
    private ForumDetailValue _value;
    
    /** Creates a new instance of ForumDetail */
    public ForumDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of ForumDetail */
    public ForumDetail(ForumDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public ForumDetailFactory getBaseFactoryInstance() {
        return ForumDetailFactory.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 ForumDetail that) {
            ForumDetailValue thatValue = that.getForumDetailValue();
            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 ForumDetailValue getForumDetailValue() {
        return _value;
    }
    
    public void setForumDetailValue(@Nonnull ForumDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public ForumDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public ForumPK getForumPK() {
        return _value.getForumPK();
    }
    
    @Nonnull
    public Forum getForum(EntityPermission entityPermission) {
        return ForumFactory.getInstance().getEntityFromPK(entityPermission, getForumPK());
    }
    
    @Nonnull
    public Forum getForum() {
        return getForum(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Forum getForumForUpdate() {
        return getForum(EntityPermission.READ_WRITE);
    }
    
    public void setForumPK(@Nonnull ForumPK forumPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setForumPK(forumPK);
    }
    
    public void setForum(@Nonnull Forum entity) {
        setForumPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getForumPKHasBeenModified() {
        return _value.getForumPKHasBeenModified();
    }
    
    @Nonnull
    public String getForumName() {
        return _value.getForumName();
    }
    
    public void setForumName(@Nonnull String forumName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setForumName(forumName);
    }
    
    public boolean getForumNameHasBeenModified() {
        return _value.getForumNameHasBeenModified();
    }
    
    @Nonnull
    public ForumTypePK getForumTypePK() {
        return _value.getForumTypePK();
    }
    
    @Nonnull
    public ForumType getForumType(EntityPermission entityPermission) {
        return ForumTypeFactory.getInstance().getEntityFromPK(entityPermission, getForumTypePK());
    }
    
    @Nonnull
    public ForumType getForumType() {
        return getForumType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public ForumType getForumTypeForUpdate() {
        return getForumType(EntityPermission.READ_WRITE);
    }
    
    public void setForumTypePK(@Nonnull ForumTypePK forumTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setForumTypePK(forumTypePK);
    }
    
    public void setForumType(@Nonnull ForumType entity) {
        setForumTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getForumTypePKHasBeenModified() {
        return _value.getForumTypePKHasBeenModified();
    }
    
    @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();
    }
    
    @Nullable
    public SequencePK getForumThreadSequencePK() {
        return _value.getForumThreadSequencePK();
    }
    
    @Nullable
    public Sequence getForumThreadSequence(EntityPermission entityPermission) {
        SequencePK pk = getForumThreadSequencePK();
        Sequence entity = pk == null? null: SequenceFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Sequence getForumThreadSequence() {
        return getForumThreadSequence(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Sequence getForumThreadSequenceForUpdate() {
        return getForumThreadSequence(EntityPermission.READ_WRITE);
    }
    
    public void setForumThreadSequencePK(@Nullable SequencePK forumThreadSequencePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setForumThreadSequencePK(forumThreadSequencePK);
    }
    
    public void setForumThreadSequence(@Nullable Sequence entity) {
        setForumThreadSequencePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getForumThreadSequencePKHasBeenModified() {
        return _value.getForumThreadSequencePKHasBeenModified();
    }
    
    @Nullable
    public SequencePK getForumMessageSequencePK() {
        return _value.getForumMessageSequencePK();
    }
    
    @Nullable
    public Sequence getForumMessageSequence(EntityPermission entityPermission) {
        SequencePK pk = getForumMessageSequencePK();
        Sequence entity = pk == null? null: SequenceFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Sequence getForumMessageSequence() {
        return getForumMessageSequence(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Sequence getForumMessageSequenceForUpdate() {
        return getForumMessageSequence(EntityPermission.READ_WRITE);
    }
    
    public void setForumMessageSequencePK(@Nullable SequencePK forumMessageSequencePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setForumMessageSequencePK(forumMessageSequencePK);
    }
    
    public void setForumMessageSequence(@Nullable Sequence entity) {
        setForumMessageSequencePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getForumMessageSequencePKHasBeenModified() {
        return _value.getForumMessageSequencePKHasBeenModified();
    }
    
    @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();
    }
    
}