001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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 * ForumMessageDetail.java
021 */
022
023package com.echothree.model.data.forum.server.entity;
024
025import com.echothree.model.data.forum.common.pk.ForumMessageDetailPK;
026
027import com.echothree.model.data.forum.common.pk.ForumMessagePK;
028import com.echothree.model.data.forum.common.pk.ForumThreadPK;
029import com.echothree.model.data.forum.common.pk.ForumMessageTypePK;
030import com.echothree.model.data.icon.common.pk.IconPK;
031
032import com.echothree.model.data.forum.server.entity.ForumMessage;
033import com.echothree.model.data.forum.server.entity.ForumThread;
034import com.echothree.model.data.forum.server.entity.ForumMessageType;
035import com.echothree.model.data.icon.server.entity.Icon;
036
037import com.echothree.model.data.forum.server.factory.ForumMessageFactory;
038import com.echothree.model.data.forum.server.factory.ForumThreadFactory;
039import com.echothree.model.data.forum.server.factory.ForumMessageTypeFactory;
040import com.echothree.model.data.icon.server.factory.IconFactory;
041
042import com.echothree.model.data.forum.common.pk.ForumMessageDetailPK;
043
044import com.echothree.model.data.forum.server.value.ForumMessageDetailValue;
045
046import com.echothree.model.data.forum.server.factory.ForumMessageDetailFactory;
047
048import com.echothree.util.common.exception.PersistenceException;
049import com.echothree.util.common.exception.PersistenceDatabaseException;
050import com.echothree.util.common.exception.PersistenceNotNullException;
051import com.echothree.util.common.exception.PersistenceReadOnlyException;
052
053import com.echothree.util.common.persistence.BasePK;
054
055import com.echothree.util.common.persistence.type.ByteArray;
056
057import com.echothree.util.server.persistence.BaseEntity;
058import com.echothree.util.server.persistence.EntityPermission;
059import com.echothree.util.server.persistence.Session;
060import com.echothree.util.server.persistence.ThreadSession;
061
062import java.io.Serializable;
063
064public class ForumMessageDetail
065        extends BaseEntity
066        implements Serializable {
067    
068    private ForumMessageDetailPK _pk;
069    private ForumMessageDetailValue _value;
070    
071    /** Creates a new instance of ForumMessageDetail */
072    public ForumMessageDetail()
073            throws PersistenceException {
074        super();
075    }
076    
077    /** Creates a new instance of ForumMessageDetail */
078    public ForumMessageDetail(ForumMessageDetailValue value, EntityPermission entityPermission) {
079        super(entityPermission);
080        
081        _value = value;
082        _pk = value.getPrimaryKey();
083    }
084    
085    @Override
086    public ForumMessageDetailFactory getBaseFactoryInstance() {
087        return ForumMessageDetailFactory.getInstance();
088    }
089    
090    @Override
091    public boolean hasBeenModified() {
092        return _value.hasBeenModified();
093    }
094    
095    @Override
096    public int hashCode() {
097        return _pk.hashCode();
098    }
099    
100    @Override
101    public String toString() {
102        return _pk.toString();
103    }
104    
105    @Override
106    public boolean equals(Object other) {
107        if(this == other)
108            return true;
109        
110        if(other instanceof ForumMessageDetail that) {
111            ForumMessageDetailValue thatValue = that.getForumMessageDetailValue();
112            return _value.equals(thatValue);
113        } else {
114            return false;
115        }
116    }
117    
118    @Override
119    public void store(Session session)
120            throws PersistenceDatabaseException {
121        getBaseFactoryInstance().store(session, this);
122    }
123    
124    @Override
125    public void remove(Session session)
126            throws PersistenceDatabaseException {
127        getBaseFactoryInstance().remove(session, this);
128    }
129    
130    @Override
131    public void remove()
132            throws PersistenceDatabaseException {
133        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
134    }
135    
136    public ForumMessageDetailValue getForumMessageDetailValue() {
137        return _value;
138    }
139    
140    public void setForumMessageDetailValue(ForumMessageDetailValue value)
141            throws PersistenceReadOnlyException {
142        checkReadWrite();
143        _value = value;
144    }
145    
146    @Override
147    public ForumMessageDetailPK getPrimaryKey() {
148        return _pk;
149    }
150    
151    public ForumMessagePK getForumMessagePK() {
152        return _value.getForumMessagePK();
153    }
154    
155    public ForumMessage getForumMessage(Session session, EntityPermission entityPermission) {
156        return ForumMessageFactory.getInstance().getEntityFromPK(session, entityPermission, getForumMessagePK());
157    }
158    
159    public ForumMessage getForumMessage(EntityPermission entityPermission) {
160        return getForumMessage(ThreadSession.currentSession(), entityPermission);
161    }
162    
163    public ForumMessage getForumMessage(Session session) {
164        return getForumMessage(session, EntityPermission.READ_ONLY);
165    }
166    
167    public ForumMessage getForumMessage() {
168        return getForumMessage(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
169    }
170    
171    public ForumMessage getForumMessageForUpdate(Session session) {
172        return getForumMessage(session, EntityPermission.READ_WRITE);
173    }
174    
175    public ForumMessage getForumMessageForUpdate() {
176        return getForumMessage(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
177    }
178    
179    public void setForumMessagePK(ForumMessagePK forumMessagePK)
180            throws PersistenceNotNullException, PersistenceReadOnlyException {
181        checkReadWrite();
182        _value.setForumMessagePK(forumMessagePK);
183    }
184    
185    public void setForumMessage(ForumMessage entity) {
186        setForumMessagePK(entity == null? null: entity.getPrimaryKey());
187    }
188    
189    public boolean getForumMessagePKHasBeenModified() {
190        return _value.getForumMessagePKHasBeenModified();
191    }
192    
193    public String getForumMessageName() {
194        return _value.getForumMessageName();
195    }
196    
197    public void setForumMessageName(String forumMessageName)
198            throws PersistenceNotNullException, PersistenceReadOnlyException {
199        checkReadWrite();
200        _value.setForumMessageName(forumMessageName);
201    }
202    
203    public boolean getForumMessageNameHasBeenModified() {
204        return _value.getForumMessageNameHasBeenModified();
205    }
206    
207    public ForumThreadPK getForumThreadPK() {
208        return _value.getForumThreadPK();
209    }
210    
211    public ForumThread getForumThread(Session session, EntityPermission entityPermission) {
212        return ForumThreadFactory.getInstance().getEntityFromPK(session, entityPermission, getForumThreadPK());
213    }
214    
215    public ForumThread getForumThread(EntityPermission entityPermission) {
216        return getForumThread(ThreadSession.currentSession(), entityPermission);
217    }
218    
219    public ForumThread getForumThread(Session session) {
220        return getForumThread(session, EntityPermission.READ_ONLY);
221    }
222    
223    public ForumThread getForumThread() {
224        return getForumThread(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
225    }
226    
227    public ForumThread getForumThreadForUpdate(Session session) {
228        return getForumThread(session, EntityPermission.READ_WRITE);
229    }
230    
231    public ForumThread getForumThreadForUpdate() {
232        return getForumThread(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
233    }
234    
235    public void setForumThreadPK(ForumThreadPK forumThreadPK)
236            throws PersistenceNotNullException, PersistenceReadOnlyException {
237        checkReadWrite();
238        _value.setForumThreadPK(forumThreadPK);
239    }
240    
241    public void setForumThread(ForumThread entity) {
242        setForumThreadPK(entity == null? null: entity.getPrimaryKey());
243    }
244    
245    public boolean getForumThreadPKHasBeenModified() {
246        return _value.getForumThreadPKHasBeenModified();
247    }
248    
249    public ForumMessageTypePK getForumMessageTypePK() {
250        return _value.getForumMessageTypePK();
251    }
252    
253    public ForumMessageType getForumMessageType(Session session, EntityPermission entityPermission) {
254        return ForumMessageTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getForumMessageTypePK());
255    }
256    
257    public ForumMessageType getForumMessageType(EntityPermission entityPermission) {
258        return getForumMessageType(ThreadSession.currentSession(), entityPermission);
259    }
260    
261    public ForumMessageType getForumMessageType(Session session) {
262        return getForumMessageType(session, EntityPermission.READ_ONLY);
263    }
264    
265    public ForumMessageType getForumMessageType() {
266        return getForumMessageType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
267    }
268    
269    public ForumMessageType getForumMessageTypeForUpdate(Session session) {
270        return getForumMessageType(session, EntityPermission.READ_WRITE);
271    }
272    
273    public ForumMessageType getForumMessageTypeForUpdate() {
274        return getForumMessageType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
275    }
276    
277    public void setForumMessageTypePK(ForumMessageTypePK forumMessageTypePK)
278            throws PersistenceNotNullException, PersistenceReadOnlyException {
279        checkReadWrite();
280        _value.setForumMessageTypePK(forumMessageTypePK);
281    }
282    
283    public void setForumMessageType(ForumMessageType entity) {
284        setForumMessageTypePK(entity == null? null: entity.getPrimaryKey());
285    }
286    
287    public boolean getForumMessageTypePKHasBeenModified() {
288        return _value.getForumMessageTypePKHasBeenModified();
289    }
290    
291    public ForumMessagePK getParentForumMessagePK() {
292        return _value.getParentForumMessagePK();
293    }
294    
295    public ForumMessage getParentForumMessage(Session session, EntityPermission entityPermission) {
296        ForumMessagePK pk = getParentForumMessagePK();
297        ForumMessage entity = pk == null? null: ForumMessageFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
298        
299        return entity;
300    }
301    
302    public ForumMessage getParentForumMessage(EntityPermission entityPermission) {
303        return getParentForumMessage(ThreadSession.currentSession(), entityPermission);
304    }
305    
306    public ForumMessage getParentForumMessage(Session session) {
307        return getParentForumMessage(session, EntityPermission.READ_ONLY);
308    }
309    
310    public ForumMessage getParentForumMessage() {
311        return getParentForumMessage(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
312    }
313    
314    public ForumMessage getParentForumMessageForUpdate(Session session) {
315        return getParentForumMessage(session, EntityPermission.READ_WRITE);
316    }
317    
318    public ForumMessage getParentForumMessageForUpdate() {
319        return getParentForumMessage(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
320    }
321    
322    public void setParentForumMessagePK(ForumMessagePK parentForumMessagePK)
323            throws PersistenceNotNullException, PersistenceReadOnlyException {
324        checkReadWrite();
325        _value.setParentForumMessagePK(parentForumMessagePK);
326    }
327    
328    public void setParentForumMessage(ForumMessage entity) {
329        setParentForumMessagePK(entity == null? null: entity.getPrimaryKey());
330    }
331    
332    public boolean getParentForumMessagePKHasBeenModified() {
333        return _value.getParentForumMessagePKHasBeenModified();
334    }
335    
336    public IconPK getIconPK() {
337        return _value.getIconPK();
338    }
339    
340    public Icon getIcon(Session session, EntityPermission entityPermission) {
341        IconPK pk = getIconPK();
342        Icon entity = pk == null? null: IconFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
343        
344        return entity;
345    }
346    
347    public Icon getIcon(EntityPermission entityPermission) {
348        return getIcon(ThreadSession.currentSession(), entityPermission);
349    }
350    
351    public Icon getIcon(Session session) {
352        return getIcon(session, EntityPermission.READ_ONLY);
353    }
354    
355    public Icon getIcon() {
356        return getIcon(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
357    }
358    
359    public Icon getIconForUpdate(Session session) {
360        return getIcon(session, EntityPermission.READ_WRITE);
361    }
362    
363    public Icon getIconForUpdate() {
364        return getIcon(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
365    }
366    
367    public void setIconPK(IconPK iconPK)
368            throws PersistenceNotNullException, PersistenceReadOnlyException {
369        checkReadWrite();
370        _value.setIconPK(iconPK);
371    }
372    
373    public void setIcon(Icon entity) {
374        setIconPK(entity == null? null: entity.getPrimaryKey());
375    }
376    
377    public boolean getIconPKHasBeenModified() {
378        return _value.getIconPKHasBeenModified();
379    }
380    
381    public Long getPostedTime() {
382        return _value.getPostedTime();
383    }
384    
385    public void setPostedTime(Long postedTime)
386            throws PersistenceNotNullException, PersistenceReadOnlyException {
387        checkReadWrite();
388        _value.setPostedTime(postedTime);
389    }
390    
391    public boolean getPostedTimeHasBeenModified() {
392        return _value.getPostedTimeHasBeenModified();
393    }
394    
395    public Long getFromTime() {
396        return _value.getFromTime();
397    }
398    
399    public void setFromTime(Long fromTime)
400            throws PersistenceNotNullException, PersistenceReadOnlyException {
401        checkReadWrite();
402        _value.setFromTime(fromTime);
403    }
404    
405    public boolean getFromTimeHasBeenModified() {
406        return _value.getFromTimeHasBeenModified();
407    }
408    
409    public Long getThruTime() {
410        return _value.getThruTime();
411    }
412    
413    public void setThruTime(Long thruTime)
414            throws PersistenceNotNullException, PersistenceReadOnlyException {
415        checkReadWrite();
416        _value.setThruTime(thruTime);
417    }
418    
419    public boolean getThruTimeHasBeenModified() {
420        return _value.getThruTimeHasBeenModified();
421    }
422    
423}