001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 Echo Three, LLC
003//
004// Licensed under the Apache License, Version 2.0 (the "License");
005// you may not use this file except in compliance with the License.
006// You may obtain a copy of the License at
007//
008//     http://www.apache.org/licenses/LICENSE-2.0
009//
010// Unless required by applicable law or agreed to in writing, software
011// distributed under the License is distributed on an "AS IS" BASIS,
012// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013// See the License for the specific language governing permissions and
014// limitations under the License.
015// --------------------------------------------------------------------------------
016// Generated File -- DO NOT EDIT BY HAND
017// --------------------------------------------------------------------------------
018
019/**
020 * MessageString.java
021 */
022
023package com.echothree.model.data.message.server.entity;
024
025import com.echothree.model.data.message.common.pk.MessageStringPK;
026
027import com.echothree.model.data.message.common.pk.MessagePK;
028import com.echothree.model.data.party.common.pk.LanguagePK;
029
030import com.echothree.model.data.message.server.entity.Message;
031import com.echothree.model.data.party.server.entity.Language;
032
033import com.echothree.model.data.message.server.factory.MessageFactory;
034import com.echothree.model.data.party.server.factory.LanguageFactory;
035
036import com.echothree.model.data.message.common.pk.MessageStringPK;
037
038import com.echothree.model.data.message.server.value.MessageStringValue;
039
040import com.echothree.model.data.message.server.factory.MessageStringFactory;
041
042import com.echothree.util.common.exception.PersistenceException;
043import com.echothree.util.common.exception.PersistenceDatabaseException;
044import com.echothree.util.common.exception.PersistenceNotNullException;
045import com.echothree.util.common.exception.PersistenceReadOnlyException;
046
047import com.echothree.util.common.persistence.BasePK;
048
049import com.echothree.util.common.persistence.type.ByteArray;
050
051import com.echothree.util.server.persistence.BaseEntity;
052import com.echothree.util.server.persistence.EntityPermission;
053import com.echothree.util.server.persistence.Session;
054import com.echothree.util.server.persistence.ThreadSession;
055
056import java.io.Serializable;
057
058public class MessageString
059        extends BaseEntity
060        implements Serializable {
061    
062    private MessageStringPK _pk;
063    private MessageStringValue _value;
064    
065    /** Creates a new instance of MessageString */
066    public MessageString()
067            throws PersistenceException {
068        super();
069    }
070    
071    /** Creates a new instance of MessageString */
072    public MessageString(MessageStringValue value, EntityPermission entityPermission) {
073        super(entityPermission);
074        
075        _value = value;
076        _pk = value.getPrimaryKey();
077    }
078    
079    @Override
080    public MessageStringFactory getBaseFactoryInstance() {
081        return MessageStringFactory.getInstance();
082    }
083    
084    @Override
085    public boolean hasBeenModified() {
086        return _value.hasBeenModified();
087    }
088    
089    @Override
090    public int hashCode() {
091        return _pk.hashCode();
092    }
093    
094    @Override
095    public String toString() {
096        return _pk.toString();
097    }
098    
099    @Override
100    public boolean equals(Object other) {
101        if(this == other)
102            return true;
103        
104        if(other instanceof MessageString that) {
105            MessageStringValue thatValue = that.getMessageStringValue();
106            return _value.equals(thatValue);
107        } else {
108            return false;
109        }
110    }
111    
112    @Override
113    public void store()
114            throws PersistenceDatabaseException {
115        getBaseFactoryInstance().store(this);
116    }
117    
118    @Override
119    public void remove()
120            throws PersistenceDatabaseException {
121        getBaseFactoryInstance().remove(this);
122    }
123    
124    public MessageStringValue getMessageStringValue() {
125        return _value;
126    }
127    
128    public void setMessageStringValue(MessageStringValue value)
129            throws PersistenceReadOnlyException {
130        checkReadWrite();
131        _value = value;
132    }
133    
134    @Override
135    public MessageStringPK getPrimaryKey() {
136        return _pk;
137    }
138    
139    public MessagePK getMessagePK() {
140        return _value.getMessagePK();
141    }
142    
143    public Message getMessage(EntityPermission entityPermission) {
144        return MessageFactory.getInstance().getEntityFromPK(entityPermission, getMessagePK());
145    }
146    
147    public Message getMessage() {
148        return getMessage(EntityPermission.READ_ONLY);
149    }
150    
151    public Message getMessageForUpdate() {
152        return getMessage(EntityPermission.READ_WRITE);
153    }
154    
155    public void setMessagePK(MessagePK messagePK)
156            throws PersistenceNotNullException, PersistenceReadOnlyException {
157        checkReadWrite();
158        _value.setMessagePK(messagePK);
159    }
160    
161    public void setMessage(Message entity) {
162        setMessagePK(entity == null? null: entity.getPrimaryKey());
163    }
164    
165    public boolean getMessagePKHasBeenModified() {
166        return _value.getMessagePKHasBeenModified();
167    }
168    
169    public LanguagePK getLanguagePK() {
170        return _value.getLanguagePK();
171    }
172    
173    public Language getLanguage(EntityPermission entityPermission) {
174        return LanguageFactory.getInstance().getEntityFromPK(entityPermission, getLanguagePK());
175    }
176    
177    public Language getLanguage() {
178        return getLanguage(EntityPermission.READ_ONLY);
179    }
180    
181    public Language getLanguageForUpdate() {
182        return getLanguage(EntityPermission.READ_WRITE);
183    }
184    
185    public void setLanguagePK(LanguagePK languagePK)
186            throws PersistenceNotNullException, PersistenceReadOnlyException {
187        checkReadWrite();
188        _value.setLanguagePK(languagePK);
189    }
190    
191    public void setLanguage(Language entity) {
192        setLanguagePK(entity == null? null: entity.getPrimaryKey());
193    }
194    
195    public boolean getLanguagePKHasBeenModified() {
196        return _value.getLanguagePKHasBeenModified();
197    }
198    
199    public String getString() {
200        return _value.getString();
201    }
202    
203    public void setString(String string)
204            throws PersistenceNotNullException, PersistenceReadOnlyException {
205        checkReadWrite();
206        _value.setString(string);
207    }
208    
209    public boolean getStringHasBeenModified() {
210        return _value.getStringHasBeenModified();
211    }
212    
213    public Long getFromTime() {
214        return _value.getFromTime();
215    }
216    
217    public void setFromTime(Long fromTime)
218            throws PersistenceNotNullException, PersistenceReadOnlyException {
219        checkReadWrite();
220        _value.setFromTime(fromTime);
221    }
222    
223    public boolean getFromTimeHasBeenModified() {
224        return _value.getFromTimeHasBeenModified();
225    }
226    
227    public Long getThruTime() {
228        return _value.getThruTime();
229    }
230    
231    public void setThruTime(Long thruTime)
232            throws PersistenceNotNullException, PersistenceReadOnlyException {
233        checkReadWrite();
234        _value.setThruTime(thruTime);
235    }
236    
237    public boolean getThruTimeHasBeenModified() {
238        return _value.getThruTimeHasBeenModified();
239    }
240    
241}