001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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) {
111            ForumDetail that = (ForumDetail)other;
112            
113            ForumDetailValue thatValue = that.getForumDetailValue();
114            return _value.equals(thatValue);
115        } else {
116            return false;
117        }
118    }
119    
120    @Override
121    public void store(Session session)
122            throws PersistenceDatabaseException {
123        getBaseFactoryInstance().store(session, this);
124    }
125    
126    @Override
127    public void remove(Session session)
128            throws PersistenceDatabaseException {
129        getBaseFactoryInstance().remove(session, this);
130    }
131    
132    @Override
133    public void remove()
134            throws PersistenceDatabaseException {
135        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
136    }
137    
138    public ForumDetailValue getForumDetailValue() {
139        return _value;
140    }
141    
142    public void setForumDetailValue(ForumDetailValue value)
143            throws PersistenceReadOnlyException {
144        checkReadWrite();
145        _value = value;
146    }
147    
148    @Override
149    public ForumDetailPK getPrimaryKey() {
150        return _pk;
151    }
152    
153    public ForumPK getForumPK() {
154        return _value.getForumPK();
155    }
156    
157    public Forum getForum(Session session, EntityPermission entityPermission) {
158        return ForumFactory.getInstance().getEntityFromPK(session, entityPermission, getForumPK());
159    }
160    
161    public Forum getForum(EntityPermission entityPermission) {
162        return getForum(ThreadSession.currentSession(), entityPermission);
163    }
164    
165    public Forum getForum(Session session) {
166        return getForum(session, EntityPermission.READ_ONLY);
167    }
168    
169    public Forum getForum() {
170        return getForum(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
171    }
172    
173    public Forum getForumForUpdate(Session session) {
174        return getForum(session, EntityPermission.READ_WRITE);
175    }
176    
177    public Forum getForumForUpdate() {
178        return getForum(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
179    }
180    
181    public void setForumPK(ForumPK forumPK)
182            throws PersistenceNotNullException, PersistenceReadOnlyException {
183        checkReadWrite();
184        _value.setForumPK(forumPK);
185    }
186    
187    public void setForum(Forum entity) {
188        setForumPK(entity == null? null: entity.getPrimaryKey());
189    }
190    
191    public boolean getForumPKHasBeenModified() {
192        return _value.getForumPKHasBeenModified();
193    }
194    
195    public String getForumName() {
196        return _value.getForumName();
197    }
198    
199    public void setForumName(String forumName)
200            throws PersistenceNotNullException, PersistenceReadOnlyException {
201        checkReadWrite();
202        _value.setForumName(forumName);
203    }
204    
205    public boolean getForumNameHasBeenModified() {
206        return _value.getForumNameHasBeenModified();
207    }
208    
209    public ForumTypePK getForumTypePK() {
210        return _value.getForumTypePK();
211    }
212    
213    public ForumType getForumType(Session session, EntityPermission entityPermission) {
214        return ForumTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getForumTypePK());
215    }
216    
217    public ForumType getForumType(EntityPermission entityPermission) {
218        return getForumType(ThreadSession.currentSession(), entityPermission);
219    }
220    
221    public ForumType getForumType(Session session) {
222        return getForumType(session, EntityPermission.READ_ONLY);
223    }
224    
225    public ForumType getForumType() {
226        return getForumType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
227    }
228    
229    public ForumType getForumTypeForUpdate(Session session) {
230        return getForumType(session, EntityPermission.READ_WRITE);
231    }
232    
233    public ForumType getForumTypeForUpdate() {
234        return getForumType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
235    }
236    
237    public void setForumTypePK(ForumTypePK forumTypePK)
238            throws PersistenceNotNullException, PersistenceReadOnlyException {
239        checkReadWrite();
240        _value.setForumTypePK(forumTypePK);
241    }
242    
243    public void setForumType(ForumType entity) {
244        setForumTypePK(entity == null? null: entity.getPrimaryKey());
245    }
246    
247    public boolean getForumTypePKHasBeenModified() {
248        return _value.getForumTypePKHasBeenModified();
249    }
250    
251    public IconPK getIconPK() {
252        return _value.getIconPK();
253    }
254    
255    public Icon getIcon(Session session, EntityPermission entityPermission) {
256        IconPK pk = getIconPK();
257        Icon entity = pk == null? null: IconFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
258        
259        return entity;
260    }
261    
262    public Icon getIcon(EntityPermission entityPermission) {
263        return getIcon(ThreadSession.currentSession(), entityPermission);
264    }
265    
266    public Icon getIcon(Session session) {
267        return getIcon(session, EntityPermission.READ_ONLY);
268    }
269    
270    public Icon getIcon() {
271        return getIcon(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
272    }
273    
274    public Icon getIconForUpdate(Session session) {
275        return getIcon(session, EntityPermission.READ_WRITE);
276    }
277    
278    public Icon getIconForUpdate() {
279        return getIcon(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
280    }
281    
282    public void setIconPK(IconPK iconPK)
283            throws PersistenceNotNullException, PersistenceReadOnlyException {
284        checkReadWrite();
285        _value.setIconPK(iconPK);
286    }
287    
288    public void setIcon(Icon entity) {
289        setIconPK(entity == null? null: entity.getPrimaryKey());
290    }
291    
292    public boolean getIconPKHasBeenModified() {
293        return _value.getIconPKHasBeenModified();
294    }
295    
296    public SequencePK getForumThreadSequencePK() {
297        return _value.getForumThreadSequencePK();
298    }
299    
300    public Sequence getForumThreadSequence(Session session, EntityPermission entityPermission) {
301        SequencePK pk = getForumThreadSequencePK();
302        Sequence entity = pk == null? null: SequenceFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
303        
304        return entity;
305    }
306    
307    public Sequence getForumThreadSequence(EntityPermission entityPermission) {
308        return getForumThreadSequence(ThreadSession.currentSession(), entityPermission);
309    }
310    
311    public Sequence getForumThreadSequence(Session session) {
312        return getForumThreadSequence(session, EntityPermission.READ_ONLY);
313    }
314    
315    public Sequence getForumThreadSequence() {
316        return getForumThreadSequence(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
317    }
318    
319    public Sequence getForumThreadSequenceForUpdate(Session session) {
320        return getForumThreadSequence(session, EntityPermission.READ_WRITE);
321    }
322    
323    public Sequence getForumThreadSequenceForUpdate() {
324        return getForumThreadSequence(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
325    }
326    
327    public void setForumThreadSequencePK(SequencePK forumThreadSequencePK)
328            throws PersistenceNotNullException, PersistenceReadOnlyException {
329        checkReadWrite();
330        _value.setForumThreadSequencePK(forumThreadSequencePK);
331    }
332    
333    public void setForumThreadSequence(Sequence entity) {
334        setForumThreadSequencePK(entity == null? null: entity.getPrimaryKey());
335    }
336    
337    public boolean getForumThreadSequencePKHasBeenModified() {
338        return _value.getForumThreadSequencePKHasBeenModified();
339    }
340    
341    public SequencePK getForumMessageSequencePK() {
342        return _value.getForumMessageSequencePK();
343    }
344    
345    public Sequence getForumMessageSequence(Session session, EntityPermission entityPermission) {
346        SequencePK pk = getForumMessageSequencePK();
347        Sequence entity = pk == null? null: SequenceFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
348        
349        return entity;
350    }
351    
352    public Sequence getForumMessageSequence(EntityPermission entityPermission) {
353        return getForumMessageSequence(ThreadSession.currentSession(), entityPermission);
354    }
355    
356    public Sequence getForumMessageSequence(Session session) {
357        return getForumMessageSequence(session, EntityPermission.READ_ONLY);
358    }
359    
360    public Sequence getForumMessageSequence() {
361        return getForumMessageSequence(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
362    }
363    
364    public Sequence getForumMessageSequenceForUpdate(Session session) {
365        return getForumMessageSequence(session, EntityPermission.READ_WRITE);
366    }
367    
368    public Sequence getForumMessageSequenceForUpdate() {
369        return getForumMessageSequence(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
370    }
371    
372    public void setForumMessageSequencePK(SequencePK forumMessageSequencePK)
373            throws PersistenceNotNullException, PersistenceReadOnlyException {
374        checkReadWrite();
375        _value.setForumMessageSequencePK(forumMessageSequencePK);
376    }
377    
378    public void setForumMessageSequence(Sequence entity) {
379        setForumMessageSequencePK(entity == null? null: entity.getPrimaryKey());
380    }
381    
382    public boolean getForumMessageSequencePKHasBeenModified() {
383        return _value.getForumMessageSequencePKHasBeenModified();
384    }
385    
386    public Integer getSortOrder() {
387        return _value.getSortOrder();
388    }
389    
390    public void setSortOrder(Integer sortOrder)
391            throws PersistenceNotNullException, PersistenceReadOnlyException {
392        checkReadWrite();
393        _value.setSortOrder(sortOrder);
394    }
395    
396    public boolean getSortOrderHasBeenModified() {
397        return _value.getSortOrderHasBeenModified();
398    }
399    
400    public Long getFromTime() {
401        return _value.getFromTime();
402    }
403    
404    public void setFromTime(Long fromTime)
405            throws PersistenceNotNullException, PersistenceReadOnlyException {
406        checkReadWrite();
407        _value.setFromTime(fromTime);
408    }
409    
410    public boolean getFromTimeHasBeenModified() {
411        return _value.getFromTimeHasBeenModified();
412    }
413    
414    public Long getThruTime() {
415        return _value.getThruTime();
416    }
417    
418    public void setThruTime(Long thruTime)
419            throws PersistenceNotNullException, PersistenceReadOnlyException {
420        checkReadWrite();
421        _value.setThruTime(thruTime);
422    }
423    
424    public boolean getThruTimeHasBeenModified() {
425        return _value.getThruTimeHasBeenModified();
426    }
427    
428}