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

/**
 * ForumMessageDetail.java
 */

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

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

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

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

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

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

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

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

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;

public class ForumMessageDetail
        extends BaseEntity
        implements Serializable {
    
    private ForumMessageDetailPK _pk;
    private ForumMessageDetailValue _value;
    
    /** Creates a new instance of ForumMessageDetail */
    public ForumMessageDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of ForumMessageDetail */
    public ForumMessageDetail(ForumMessageDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    public ForumMessageDetailFactory getBaseFactoryInstance() {
        return ForumMessageDetailFactory.getInstance();
    }
    
    @Override
    public boolean hasBeenModified() {
        return _value.hasBeenModified();
    }
    
    @Override
    public int hashCode() {
        return _pk.hashCode();
    }
    
    @Override
    public String toString() {
        return _pk.toString();
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(other instanceof ForumMessageDetail that) {
            ForumMessageDetailValue thatValue = that.getForumMessageDetailValue();
            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);
    }
    
    public ForumMessageDetailValue getForumMessageDetailValue() {
        return _value;
    }
    
    public void setForumMessageDetailValue(ForumMessageDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    public ForumMessageDetailPK getPrimaryKey() {
        return _pk;
    }
    
    public ForumMessagePK getForumMessagePK() {
        return _value.getForumMessagePK();
    }
    
    public ForumMessage getForumMessage(EntityPermission entityPermission) {
        return ForumMessageFactory.getInstance().getEntityFromPK(entityPermission, getForumMessagePK());
    }
    
    public ForumMessage getForumMessage() {
        return getForumMessage(EntityPermission.READ_ONLY);
    }
    
    public ForumMessage getForumMessageForUpdate() {
        return getForumMessage(EntityPermission.READ_WRITE);
    }
    
    public void setForumMessagePK(ForumMessagePK forumMessagePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setForumMessagePK(forumMessagePK);
    }
    
    public void setForumMessage(ForumMessage entity) {
        setForumMessagePK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getForumMessagePKHasBeenModified() {
        return _value.getForumMessagePKHasBeenModified();
    }
    
    public String getForumMessageName() {
        return _value.getForumMessageName();
    }
    
    public void setForumMessageName(String forumMessageName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setForumMessageName(forumMessageName);
    }
    
    public boolean getForumMessageNameHasBeenModified() {
        return _value.getForumMessageNameHasBeenModified();
    }
    
    public ForumThreadPK getForumThreadPK() {
        return _value.getForumThreadPK();
    }
    
    public ForumThread getForumThread(EntityPermission entityPermission) {
        return ForumThreadFactory.getInstance().getEntityFromPK(entityPermission, getForumThreadPK());
    }
    
    public ForumThread getForumThread() {
        return getForumThread(EntityPermission.READ_ONLY);
    }
    
    public ForumThread getForumThreadForUpdate() {
        return getForumThread(EntityPermission.READ_WRITE);
    }
    
    public void setForumThreadPK(ForumThreadPK forumThreadPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setForumThreadPK(forumThreadPK);
    }
    
    public void setForumThread(ForumThread entity) {
        setForumThreadPK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getForumThreadPKHasBeenModified() {
        return _value.getForumThreadPKHasBeenModified();
    }
    
    public ForumMessageTypePK getForumMessageTypePK() {
        return _value.getForumMessageTypePK();
    }
    
    public ForumMessageType getForumMessageType(EntityPermission entityPermission) {
        return ForumMessageTypeFactory.getInstance().getEntityFromPK(entityPermission, getForumMessageTypePK());
    }
    
    public ForumMessageType getForumMessageType() {
        return getForumMessageType(EntityPermission.READ_ONLY);
    }
    
    public ForumMessageType getForumMessageTypeForUpdate() {
        return getForumMessageType(EntityPermission.READ_WRITE);
    }
    
    public void setForumMessageTypePK(ForumMessageTypePK forumMessageTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setForumMessageTypePK(forumMessageTypePK);
    }
    
    public void setForumMessageType(ForumMessageType entity) {
        setForumMessageTypePK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getForumMessageTypePKHasBeenModified() {
        return _value.getForumMessageTypePKHasBeenModified();
    }
    
    public ForumMessagePK getParentForumMessagePK() {
        return _value.getParentForumMessagePK();
    }
    
    public ForumMessage getParentForumMessage(EntityPermission entityPermission) {
        ForumMessagePK pk = getParentForumMessagePK();
        ForumMessage entity = pk == null? null: ForumMessageFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    public ForumMessage getParentForumMessage() {
        return getParentForumMessage(EntityPermission.READ_ONLY);
    }
    
    public ForumMessage getParentForumMessageForUpdate() {
        return getParentForumMessage(EntityPermission.READ_WRITE);
    }
    
    public void setParentForumMessagePK(ForumMessagePK parentForumMessagePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setParentForumMessagePK(parentForumMessagePK);
    }
    
    public void setParentForumMessage(ForumMessage entity) {
        setParentForumMessagePK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getParentForumMessagePKHasBeenModified() {
        return _value.getParentForumMessagePKHasBeenModified();
    }
    
    public IconPK getIconPK() {
        return _value.getIconPK();
    }
    
    public Icon getIcon(EntityPermission entityPermission) {
        IconPK pk = getIconPK();
        Icon entity = pk == null? null: IconFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    public Icon getIcon() {
        return getIcon(EntityPermission.READ_ONLY);
    }
    
    public Icon getIconForUpdate() {
        return getIcon(EntityPermission.READ_WRITE);
    }
    
    public void setIconPK(IconPK iconPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setIconPK(iconPK);
    }
    
    public void setIcon(Icon entity) {
        setIconPK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getIconPKHasBeenModified() {
        return _value.getIconPKHasBeenModified();
    }
    
    public Long getPostedTime() {
        return _value.getPostedTime();
    }
    
    public void setPostedTime(Long postedTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPostedTime(postedTime);
    }
    
    public boolean getPostedTimeHasBeenModified() {
        return _value.getPostedTimeHasBeenModified();
    }
    
    public Long getFromTime() {
        return _value.getFromTime();
    }
    
    public void setFromTime(Long fromTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setFromTime(fromTime);
    }
    
    public boolean getFromTimeHasBeenModified() {
        return _value.getFromTimeHasBeenModified();
    }
    
    public Long getThruTime() {
        return _value.getThruTime();
    }
    
    public void setThruTime(Long thruTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setThruTime(thruTime);
    }
    
    public boolean getThruTimeHasBeenModified() {
        return _value.getThruTimeHasBeenModified();
    }
    
}