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 * 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()
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 ForumGroupDetailValue getForumGroupDetailValue() {
125        return _value;
126    }
127    
128    public void setForumGroupDetailValue(ForumGroupDetailValue value)
129            throws PersistenceReadOnlyException {
130        checkReadWrite();
131        _value = value;
132    }
133    
134    @Override
135    public ForumGroupDetailPK getPrimaryKey() {
136        return _pk;
137    }
138    
139    public ForumGroupPK getForumGroupPK() {
140        return _value.getForumGroupPK();
141    }
142    
143    public ForumGroup getForumGroup(EntityPermission entityPermission) {
144        return ForumGroupFactory.getInstance().getEntityFromPK(entityPermission, getForumGroupPK());
145    }
146    
147    public ForumGroup getForumGroup() {
148        return getForumGroup(EntityPermission.READ_ONLY);
149    }
150    
151    public ForumGroup getForumGroupForUpdate() {
152        return getForumGroup(EntityPermission.READ_WRITE);
153    }
154    
155    public void setForumGroupPK(ForumGroupPK forumGroupPK)
156            throws PersistenceNotNullException, PersistenceReadOnlyException {
157        checkReadWrite();
158        _value.setForumGroupPK(forumGroupPK);
159    }
160    
161    public void setForumGroup(ForumGroup entity) {
162        setForumGroupPK(entity == null? null: entity.getPrimaryKey());
163    }
164    
165    public boolean getForumGroupPKHasBeenModified() {
166        return _value.getForumGroupPKHasBeenModified();
167    }
168    
169    public String getForumGroupName() {
170        return _value.getForumGroupName();
171    }
172    
173    public void setForumGroupName(String forumGroupName)
174            throws PersistenceNotNullException, PersistenceReadOnlyException {
175        checkReadWrite();
176        _value.setForumGroupName(forumGroupName);
177    }
178    
179    public boolean getForumGroupNameHasBeenModified() {
180        return _value.getForumGroupNameHasBeenModified();
181    }
182    
183    public IconPK getIconPK() {
184        return _value.getIconPK();
185    }
186    
187    public Icon getIcon(EntityPermission entityPermission) {
188        IconPK pk = getIconPK();
189        Icon entity = pk == null? null: IconFactory.getInstance().getEntityFromPK(entityPermission, pk);
190        
191        return entity;
192    }
193    
194    public Icon getIcon() {
195        return getIcon(EntityPermission.READ_ONLY);
196    }
197    
198    public Icon getIconForUpdate() {
199        return getIcon(EntityPermission.READ_WRITE);
200    }
201    
202    public void setIconPK(IconPK iconPK)
203            throws PersistenceNotNullException, PersistenceReadOnlyException {
204        checkReadWrite();
205        _value.setIconPK(iconPK);
206    }
207    
208    public void setIcon(Icon entity) {
209        setIconPK(entity == null? null: entity.getPrimaryKey());
210    }
211    
212    public boolean getIconPKHasBeenModified() {
213        return _value.getIconPKHasBeenModified();
214    }
215    
216    public Integer getSortOrder() {
217        return _value.getSortOrder();
218    }
219    
220    public void setSortOrder(Integer sortOrder)
221            throws PersistenceNotNullException, PersistenceReadOnlyException {
222        checkReadWrite();
223        _value.setSortOrder(sortOrder);
224    }
225    
226    public boolean getSortOrderHasBeenModified() {
227        return _value.getSortOrderHasBeenModified();
228    }
229    
230    public Long getFromTime() {
231        return _value.getFromTime();
232    }
233    
234    public void setFromTime(Long fromTime)
235            throws PersistenceNotNullException, PersistenceReadOnlyException {
236        checkReadWrite();
237        _value.setFromTime(fromTime);
238    }
239    
240    public boolean getFromTimeHasBeenModified() {
241        return _value.getFromTimeHasBeenModified();
242    }
243    
244    public Long getThruTime() {
245        return _value.getThruTime();
246    }
247    
248    public void setThruTime(Long thruTime)
249            throws PersistenceNotNullException, PersistenceReadOnlyException {
250        checkReadWrite();
251        _value.setThruTime(thruTime);
252    }
253    
254    public boolean getThruTimeHasBeenModified() {
255        return _value.getThruTimeHasBeenModified();
256    }
257    
258}