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 * ForumDetail.java
021 */
022
023package com.echothree.model.data.forum.server.entity;
024
025import com.echothree.model.data.forum.common.pk.ForumDetailPK;
026
027import com.echothree.model.data.forum.common.pk.ForumPK;
028import com.echothree.model.data.forum.common.pk.ForumTypePK;
029import com.echothree.model.data.icon.common.pk.IconPK;
030import com.echothree.model.data.sequence.common.pk.SequencePK;
031
032import com.echothree.model.data.forum.server.entity.Forum;
033import com.echothree.model.data.forum.server.entity.ForumType;
034import com.echothree.model.data.icon.server.entity.Icon;
035import com.echothree.model.data.sequence.server.entity.Sequence;
036
037import com.echothree.model.data.forum.server.factory.ForumFactory;
038import com.echothree.model.data.forum.server.factory.ForumTypeFactory;
039import com.echothree.model.data.icon.server.factory.IconFactory;
040import com.echothree.model.data.sequence.server.factory.SequenceFactory;
041
042import com.echothree.model.data.forum.common.pk.ForumDetailPK;
043
044import com.echothree.model.data.forum.server.value.ForumDetailValue;
045
046import com.echothree.model.data.forum.server.factory.ForumDetailFactory;
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 ForumDetail
065        extends BaseEntity
066        implements Serializable {
067    
068    private ForumDetailPK _pk;
069    private ForumDetailValue _value;
070    
071    /** Creates a new instance of ForumDetail */
072    public ForumDetail()
073            throws PersistenceException {
074        super();
075    }
076    
077    /** Creates a new instance of ForumDetail */
078    public ForumDetail(ForumDetailValue value, EntityPermission entityPermission) {
079        super(entityPermission);
080        
081        _value = value;
082        _pk = value.getPrimaryKey();
083    }
084    
085    @Override
086    public ForumDetailFactory getBaseFactoryInstance() {
087        return ForumDetailFactory.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 ForumDetail that) {
111            ForumDetailValue thatValue = that.getForumDetailValue();
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 ForumDetailValue getForumDetailValue() {
137        return _value;
138    }
139    
140    public void setForumDetailValue(ForumDetailValue value)
141            throws PersistenceReadOnlyException {
142        checkReadWrite();
143        _value = value;
144    }
145    
146    @Override
147    public ForumDetailPK getPrimaryKey() {
148        return _pk;
149    }
150    
151    public ForumPK getForumPK() {
152        return _value.getForumPK();
153    }
154    
155    public Forum getForum(Session session, EntityPermission entityPermission) {
156        return ForumFactory.getInstance().getEntityFromPK(session, entityPermission, getForumPK());
157    }
158    
159    public Forum getForum(EntityPermission entityPermission) {
160        return getForum(ThreadSession.currentSession(), entityPermission);
161    }
162    
163    public Forum getForum(Session session) {
164        return getForum(session, EntityPermission.READ_ONLY);
165    }
166    
167    public Forum getForum() {
168        return getForum(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
169    }
170    
171    public Forum getForumForUpdate(Session session) {
172        return getForum(session, EntityPermission.READ_WRITE);
173    }
174    
175    public Forum getForumForUpdate() {
176        return getForum(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
177    }
178    
179    public void setForumPK(ForumPK forumPK)
180            throws PersistenceNotNullException, PersistenceReadOnlyException {
181        checkReadWrite();
182        _value.setForumPK(forumPK);
183    }
184    
185    public void setForum(Forum entity) {
186        setForumPK(entity == null? null: entity.getPrimaryKey());
187    }
188    
189    public boolean getForumPKHasBeenModified() {
190        return _value.getForumPKHasBeenModified();
191    }
192    
193    public String getForumName() {
194        return _value.getForumName();
195    }
196    
197    public void setForumName(String forumName)
198            throws PersistenceNotNullException, PersistenceReadOnlyException {
199        checkReadWrite();
200        _value.setForumName(forumName);
201    }
202    
203    public boolean getForumNameHasBeenModified() {
204        return _value.getForumNameHasBeenModified();
205    }
206    
207    public ForumTypePK getForumTypePK() {
208        return _value.getForumTypePK();
209    }
210    
211    public ForumType getForumType(Session session, EntityPermission entityPermission) {
212        return ForumTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getForumTypePK());
213    }
214    
215    public ForumType getForumType(EntityPermission entityPermission) {
216        return getForumType(ThreadSession.currentSession(), entityPermission);
217    }
218    
219    public ForumType getForumType(Session session) {
220        return getForumType(session, EntityPermission.READ_ONLY);
221    }
222    
223    public ForumType getForumType() {
224        return getForumType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
225    }
226    
227    public ForumType getForumTypeForUpdate(Session session) {
228        return getForumType(session, EntityPermission.READ_WRITE);
229    }
230    
231    public ForumType getForumTypeForUpdate() {
232        return getForumType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
233    }
234    
235    public void setForumTypePK(ForumTypePK forumTypePK)
236            throws PersistenceNotNullException, PersistenceReadOnlyException {
237        checkReadWrite();
238        _value.setForumTypePK(forumTypePK);
239    }
240    
241    public void setForumType(ForumType entity) {
242        setForumTypePK(entity == null? null: entity.getPrimaryKey());
243    }
244    
245    public boolean getForumTypePKHasBeenModified() {
246        return _value.getForumTypePKHasBeenModified();
247    }
248    
249    public IconPK getIconPK() {
250        return _value.getIconPK();
251    }
252    
253    public Icon getIcon(Session session, EntityPermission entityPermission) {
254        IconPK pk = getIconPK();
255        Icon entity = pk == null? null: IconFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
256        
257        return entity;
258    }
259    
260    public Icon getIcon(EntityPermission entityPermission) {
261        return getIcon(ThreadSession.currentSession(), entityPermission);
262    }
263    
264    public Icon getIcon(Session session) {
265        return getIcon(session, EntityPermission.READ_ONLY);
266    }
267    
268    public Icon getIcon() {
269        return getIcon(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
270    }
271    
272    public Icon getIconForUpdate(Session session) {
273        return getIcon(session, EntityPermission.READ_WRITE);
274    }
275    
276    public Icon getIconForUpdate() {
277        return getIcon(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
278    }
279    
280    public void setIconPK(IconPK iconPK)
281            throws PersistenceNotNullException, PersistenceReadOnlyException {
282        checkReadWrite();
283        _value.setIconPK(iconPK);
284    }
285    
286    public void setIcon(Icon entity) {
287        setIconPK(entity == null? null: entity.getPrimaryKey());
288    }
289    
290    public boolean getIconPKHasBeenModified() {
291        return _value.getIconPKHasBeenModified();
292    }
293    
294    public SequencePK getForumThreadSequencePK() {
295        return _value.getForumThreadSequencePK();
296    }
297    
298    public Sequence getForumThreadSequence(Session session, EntityPermission entityPermission) {
299        SequencePK pk = getForumThreadSequencePK();
300        Sequence entity = pk == null? null: SequenceFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
301        
302        return entity;
303    }
304    
305    public Sequence getForumThreadSequence(EntityPermission entityPermission) {
306        return getForumThreadSequence(ThreadSession.currentSession(), entityPermission);
307    }
308    
309    public Sequence getForumThreadSequence(Session session) {
310        return getForumThreadSequence(session, EntityPermission.READ_ONLY);
311    }
312    
313    public Sequence getForumThreadSequence() {
314        return getForumThreadSequence(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
315    }
316    
317    public Sequence getForumThreadSequenceForUpdate(Session session) {
318        return getForumThreadSequence(session, EntityPermission.READ_WRITE);
319    }
320    
321    public Sequence getForumThreadSequenceForUpdate() {
322        return getForumThreadSequence(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
323    }
324    
325    public void setForumThreadSequencePK(SequencePK forumThreadSequencePK)
326            throws PersistenceNotNullException, PersistenceReadOnlyException {
327        checkReadWrite();
328        _value.setForumThreadSequencePK(forumThreadSequencePK);
329    }
330    
331    public void setForumThreadSequence(Sequence entity) {
332        setForumThreadSequencePK(entity == null? null: entity.getPrimaryKey());
333    }
334    
335    public boolean getForumThreadSequencePKHasBeenModified() {
336        return _value.getForumThreadSequencePKHasBeenModified();
337    }
338    
339    public SequencePK getForumMessageSequencePK() {
340        return _value.getForumMessageSequencePK();
341    }
342    
343    public Sequence getForumMessageSequence(Session session, EntityPermission entityPermission) {
344        SequencePK pk = getForumMessageSequencePK();
345        Sequence entity = pk == null? null: SequenceFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
346        
347        return entity;
348    }
349    
350    public Sequence getForumMessageSequence(EntityPermission entityPermission) {
351        return getForumMessageSequence(ThreadSession.currentSession(), entityPermission);
352    }
353    
354    public Sequence getForumMessageSequence(Session session) {
355        return getForumMessageSequence(session, EntityPermission.READ_ONLY);
356    }
357    
358    public Sequence getForumMessageSequence() {
359        return getForumMessageSequence(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
360    }
361    
362    public Sequence getForumMessageSequenceForUpdate(Session session) {
363        return getForumMessageSequence(session, EntityPermission.READ_WRITE);
364    }
365    
366    public Sequence getForumMessageSequenceForUpdate() {
367        return getForumMessageSequence(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
368    }
369    
370    public void setForumMessageSequencePK(SequencePK forumMessageSequencePK)
371            throws PersistenceNotNullException, PersistenceReadOnlyException {
372        checkReadWrite();
373        _value.setForumMessageSequencePK(forumMessageSequencePK);
374    }
375    
376    public void setForumMessageSequence(Sequence entity) {
377        setForumMessageSequencePK(entity == null? null: entity.getPrimaryKey());
378    }
379    
380    public boolean getForumMessageSequencePKHasBeenModified() {
381        return _value.getForumMessageSequencePKHasBeenModified();
382    }
383    
384    public Integer getSortOrder() {
385        return _value.getSortOrder();
386    }
387    
388    public void setSortOrder(Integer sortOrder)
389            throws PersistenceNotNullException, PersistenceReadOnlyException {
390        checkReadWrite();
391        _value.setSortOrder(sortOrder);
392    }
393    
394    public boolean getSortOrderHasBeenModified() {
395        return _value.getSortOrderHasBeenModified();
396    }
397    
398    public Long getFromTime() {
399        return _value.getFromTime();
400    }
401    
402    public void setFromTime(Long fromTime)
403            throws PersistenceNotNullException, PersistenceReadOnlyException {
404        checkReadWrite();
405        _value.setFromTime(fromTime);
406    }
407    
408    public boolean getFromTimeHasBeenModified() {
409        return _value.getFromTimeHasBeenModified();
410    }
411    
412    public Long getThruTime() {
413        return _value.getThruTime();
414    }
415    
416    public void setThruTime(Long thruTime)
417            throws PersistenceNotNullException, PersistenceReadOnlyException {
418        checkReadWrite();
419        _value.setThruTime(thruTime);
420    }
421    
422    public boolean getThruTimeHasBeenModified() {
423        return _value.getThruTimeHasBeenModified();
424    }
425    
426}