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 * ForumGroupDetail.java
021 */
022
023package com.echothree.model.data.forum.server.entity;
024
025import com.echothree.model.data.forum.common.pk.ForumGroupDetailPK;
026
027import com.echothree.model.data.forum.common.pk.ForumGroupPK;
028import com.echothree.model.data.icon.common.pk.IconPK;
029
030import com.echothree.model.data.forum.server.entity.ForumGroup;
031import com.echothree.model.data.icon.server.entity.Icon;
032
033import com.echothree.model.data.forum.server.factory.ForumGroupFactory;
034import com.echothree.model.data.icon.server.factory.IconFactory;
035
036import com.echothree.model.data.forum.common.pk.ForumGroupDetailPK;
037
038import com.echothree.model.data.forum.server.value.ForumGroupDetailValue;
039
040import com.echothree.model.data.forum.server.factory.ForumGroupDetailFactory;
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 ForumGroupDetail
059        extends BaseEntity
060        implements Serializable {
061    
062    private ForumGroupDetailPK _pk;
063    private ForumGroupDetailValue _value;
064    
065    /** Creates a new instance of ForumGroupDetail */
066    public ForumGroupDetail()
067            throws PersistenceException {
068        super();
069    }
070    
071    /** Creates a new instance of ForumGroupDetail */
072    public ForumGroupDetail(ForumGroupDetailValue value, EntityPermission entityPermission) {
073        super(entityPermission);
074        
075        _value = value;
076        _pk = value.getPrimaryKey();
077    }
078    
079    @Override
080    public ForumGroupDetailFactory getBaseFactoryInstance() {
081        return ForumGroupDetailFactory.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 ForumGroupDetail that) {
105            ForumGroupDetailValue thatValue = that.getForumGroupDetailValue();
106            return _value.equals(thatValue);
107        } else {
108            return false;
109        }
110    }
111    
112    @Override
113    public void store(Session session)
114            throws PersistenceDatabaseException {
115        getBaseFactoryInstance().store(session, this);
116    }
117    
118    @Override
119    public void remove(Session session)
120            throws PersistenceDatabaseException {
121        getBaseFactoryInstance().remove(session, this);
122    }
123    
124    @Override
125    public void remove()
126            throws PersistenceDatabaseException {
127        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
128    }
129    
130    public ForumGroupDetailValue getForumGroupDetailValue() {
131        return _value;
132    }
133    
134    public void setForumGroupDetailValue(ForumGroupDetailValue value)
135            throws PersistenceReadOnlyException {
136        checkReadWrite();
137        _value = value;
138    }
139    
140    @Override
141    public ForumGroupDetailPK getPrimaryKey() {
142        return _pk;
143    }
144    
145    public ForumGroupPK getForumGroupPK() {
146        return _value.getForumGroupPK();
147    }
148    
149    public ForumGroup getForumGroup(Session session, EntityPermission entityPermission) {
150        return ForumGroupFactory.getInstance().getEntityFromPK(session, entityPermission, getForumGroupPK());
151    }
152    
153    public ForumGroup getForumGroup(EntityPermission entityPermission) {
154        return getForumGroup(ThreadSession.currentSession(), entityPermission);
155    }
156    
157    public ForumGroup getForumGroup(Session session) {
158        return getForumGroup(session, EntityPermission.READ_ONLY);
159    }
160    
161    public ForumGroup getForumGroup() {
162        return getForumGroup(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
163    }
164    
165    public ForumGroup getForumGroupForUpdate(Session session) {
166        return getForumGroup(session, EntityPermission.READ_WRITE);
167    }
168    
169    public ForumGroup getForumGroupForUpdate() {
170        return getForumGroup(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
171    }
172    
173    public void setForumGroupPK(ForumGroupPK forumGroupPK)
174            throws PersistenceNotNullException, PersistenceReadOnlyException {
175        checkReadWrite();
176        _value.setForumGroupPK(forumGroupPK);
177    }
178    
179    public void setForumGroup(ForumGroup entity) {
180        setForumGroupPK(entity == null? null: entity.getPrimaryKey());
181    }
182    
183    public boolean getForumGroupPKHasBeenModified() {
184        return _value.getForumGroupPKHasBeenModified();
185    }
186    
187    public String getForumGroupName() {
188        return _value.getForumGroupName();
189    }
190    
191    public void setForumGroupName(String forumGroupName)
192            throws PersistenceNotNullException, PersistenceReadOnlyException {
193        checkReadWrite();
194        _value.setForumGroupName(forumGroupName);
195    }
196    
197    public boolean getForumGroupNameHasBeenModified() {
198        return _value.getForumGroupNameHasBeenModified();
199    }
200    
201    public IconPK getIconPK() {
202        return _value.getIconPK();
203    }
204    
205    public Icon getIcon(Session session, EntityPermission entityPermission) {
206        IconPK pk = getIconPK();
207        Icon entity = pk == null? null: IconFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
208        
209        return entity;
210    }
211    
212    public Icon getIcon(EntityPermission entityPermission) {
213        return getIcon(ThreadSession.currentSession(), entityPermission);
214    }
215    
216    public Icon getIcon(Session session) {
217        return getIcon(session, EntityPermission.READ_ONLY);
218    }
219    
220    public Icon getIcon() {
221        return getIcon(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
222    }
223    
224    public Icon getIconForUpdate(Session session) {
225        return getIcon(session, EntityPermission.READ_WRITE);
226    }
227    
228    public Icon getIconForUpdate() {
229        return getIcon(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
230    }
231    
232    public void setIconPK(IconPK iconPK)
233            throws PersistenceNotNullException, PersistenceReadOnlyException {
234        checkReadWrite();
235        _value.setIconPK(iconPK);
236    }
237    
238    public void setIcon(Icon entity) {
239        setIconPK(entity == null? null: entity.getPrimaryKey());
240    }
241    
242    public boolean getIconPKHasBeenModified() {
243        return _value.getIconPKHasBeenModified();
244    }
245    
246    public Integer getSortOrder() {
247        return _value.getSortOrder();
248    }
249    
250    public void setSortOrder(Integer sortOrder)
251            throws PersistenceNotNullException, PersistenceReadOnlyException {
252        checkReadWrite();
253        _value.setSortOrder(sortOrder);
254    }
255    
256    public boolean getSortOrderHasBeenModified() {
257        return _value.getSortOrderHasBeenModified();
258    }
259    
260    public Long getFromTime() {
261        return _value.getFromTime();
262    }
263    
264    public void setFromTime(Long fromTime)
265            throws PersistenceNotNullException, PersistenceReadOnlyException {
266        checkReadWrite();
267        _value.setFromTime(fromTime);
268    }
269    
270    public boolean getFromTimeHasBeenModified() {
271        return _value.getFromTimeHasBeenModified();
272    }
273    
274    public Long getThruTime() {
275        return _value.getThruTime();
276    }
277    
278    public void setThruTime(Long thruTime)
279            throws PersistenceNotNullException, PersistenceReadOnlyException {
280        checkReadWrite();
281        _value.setThruTime(thruTime);
282    }
283    
284    public boolean getThruTimeHasBeenModified() {
285        return _value.getThruTimeHasBeenModified();
286    }
287    
288}