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

/**
 * MessageString.java
 */

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

import com.echothree.model.data.message.common.pk.MessageStringPK;

import com.echothree.model.data.message.common.pk.MessagePK;
import com.echothree.model.data.party.common.pk.LanguagePK;

import com.echothree.model.data.message.server.entity.Message;
import com.echothree.model.data.party.server.entity.Language;

import com.echothree.model.data.message.server.factory.MessageFactory;
import com.echothree.model.data.party.server.factory.LanguageFactory;

import com.echothree.model.data.message.common.pk.MessageStringPK;

import com.echothree.model.data.message.server.value.MessageStringValue;

import com.echothree.model.data.message.server.factory.MessageStringFactory;

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 MessageString
        extends BaseEntity
        implements Serializable {
    
    private MessageStringPK _pk;
    private MessageStringValue _value;
    
    /** Creates a new instance of MessageString */
    public MessageString()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of MessageString */
    public MessageString(MessageStringValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public MessageStringFactory getBaseFactoryInstance() {
        return MessageStringFactory.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 MessageString that) {
            MessageStringValue thatValue = that.getMessageStringValue();
            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 MessageStringValue getMessageStringValue() {
        return _value;
    }
    
    public void setMessageStringValue(@Nonnull MessageStringValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public MessageStringPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public MessagePK getMessagePK() {
        return _value.getMessagePK();
    }
    
    @Nonnull
    public Message getMessage(EntityPermission entityPermission) {
        return MessageFactory.getInstance().getEntityFromPK(entityPermission, getMessagePK());
    }
    
    @Nonnull
    public Message getMessage() {
        return getMessage(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Message getMessageForUpdate() {
        return getMessage(EntityPermission.READ_WRITE);
    }
    
    public void setMessagePK(@Nonnull MessagePK messagePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setMessagePK(messagePK);
    }
    
    public void setMessage(@Nonnull Message entity) {
        setMessagePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getMessagePKHasBeenModified() {
        return _value.getMessagePKHasBeenModified();
    }
    
    @Nonnull
    public LanguagePK getLanguagePK() {
        return _value.getLanguagePK();
    }
    
    @Nonnull
    public Language getLanguage(EntityPermission entityPermission) {
        return LanguageFactory.getInstance().getEntityFromPK(entityPermission, getLanguagePK());
    }
    
    @Nonnull
    public Language getLanguage() {
        return getLanguage(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Language getLanguageForUpdate() {
        return getLanguage(EntityPermission.READ_WRITE);
    }
    
    public void setLanguagePK(@Nonnull LanguagePK languagePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setLanguagePK(languagePK);
    }
    
    public void setLanguage(@Nonnull Language entity) {
        setLanguagePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getLanguagePKHasBeenModified() {
        return _value.getLanguagePKHasBeenModified();
    }
    
    @Nonnull
    public String getString() {
        return _value.getString();
    }
    
    public void setString(@Nonnull String string)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setString(string);
    }
    
    public boolean getStringHasBeenModified() {
        return _value.getStringHasBeenModified();
    }
    
    @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();
    }
    
}