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 * 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) {
105            ForumGroupDetail that = (ForumGroupDetail)other;
106            
107            ForumGroupDetailValue thatValue = that.getForumGroupDetailValue();
108            return _value.equals(thatValue);
109        } else {
110            return false;
111        }
112    }
113    
114    @Override
115    public void store(Session session)
116            throws PersistenceDatabaseException {
117        getBaseFactoryInstance().store(session, this);
118    }
119    
120    @Override
121    public void remove(Session session)
122            throws PersistenceDatabaseException {
123        getBaseFactoryInstance().remove(session, this);
124    }
125    
126    @Override
127    public void remove()
128            throws PersistenceDatabaseException {
129        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
130    }
131    
132    public ForumGroupDetailValue getForumGroupDetailValue() {
133        return _value;
134    }
135    
136    public void setForumGroupDetailValue(ForumGroupDetailValue value)
137            throws PersistenceReadOnlyException {
138        checkReadWrite();
139        _value = value;
140    }
141    
142    @Override
143    public ForumGroupDetailPK getPrimaryKey() {
144        return _pk;
145    }
146    
147    public ForumGroupPK getForumGroupPK() {
148        return _value.getForumGroupPK();
149    }
150    
151    public ForumGroup getForumGroup(Session session, EntityPermission entityPermission) {
152        return ForumGroupFactory.getInstance().getEntityFromPK(session, entityPermission, getForumGroupPK());
153    }
154    
155    public ForumGroup getForumGroup(EntityPermission entityPermission) {
156        return getForumGroup(ThreadSession.currentSession(), entityPermission);
157    }
158    
159    public ForumGroup getForumGroup(Session session) {
160        return getForumGroup(session, EntityPermission.READ_ONLY);
161    }
162    
163    public ForumGroup getForumGroup() {
164        return getForumGroup(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
165    }
166    
167    public ForumGroup getForumGroupForUpdate(Session session) {
168        return getForumGroup(session, EntityPermission.READ_WRITE);
169    }
170    
171    public ForumGroup getForumGroupForUpdate() {
172        return getForumGroup(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
173    }
174    
175    public void setForumGroupPK(ForumGroupPK forumGroupPK)
176            throws PersistenceNotNullException, PersistenceReadOnlyException {
177        checkReadWrite();
178        _value.setForumGroupPK(forumGroupPK);
179    }
180    
181    public void setForumGroup(ForumGroup entity) {
182        setForumGroupPK(entity == null? null: entity.getPrimaryKey());
183    }
184    
185    public boolean getForumGroupPKHasBeenModified() {
186        return _value.getForumGroupPKHasBeenModified();
187    }
188    
189    public String getForumGroupName() {
190        return _value.getForumGroupName();
191    }
192    
193    public void setForumGroupName(String forumGroupName)
194            throws PersistenceNotNullException, PersistenceReadOnlyException {
195        checkReadWrite();
196        _value.setForumGroupName(forumGroupName);
197    }
198    
199    public boolean getForumGroupNameHasBeenModified() {
200        return _value.getForumGroupNameHasBeenModified();
201    }
202    
203    public IconPK getIconPK() {
204        return _value.getIconPK();
205    }
206    
207    public Icon getIcon(Session session, EntityPermission entityPermission) {
208        IconPK pk = getIconPK();
209        Icon entity = pk == null? null: IconFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
210        
211        return entity;
212    }
213    
214    public Icon getIcon(EntityPermission entityPermission) {
215        return getIcon(ThreadSession.currentSession(), entityPermission);
216    }
217    
218    public Icon getIcon(Session session) {
219        return getIcon(session, EntityPermission.READ_ONLY);
220    }
221    
222    public Icon getIcon() {
223        return getIcon(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
224    }
225    
226    public Icon getIconForUpdate(Session session) {
227        return getIcon(session, EntityPermission.READ_WRITE);
228    }
229    
230    public Icon getIconForUpdate() {
231        return getIcon(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
232    }
233    
234    public void setIconPK(IconPK iconPK)
235            throws PersistenceNotNullException, PersistenceReadOnlyException {
236        checkReadWrite();
237        _value.setIconPK(iconPK);
238    }
239    
240    public void setIcon(Icon entity) {
241        setIconPK(entity == null? null: entity.getPrimaryKey());
242    }
243    
244    public boolean getIconPKHasBeenModified() {
245        return _value.getIconPKHasBeenModified();
246    }
247    
248    public Integer getSortOrder() {
249        return _value.getSortOrder();
250    }
251    
252    public void setSortOrder(Integer sortOrder)
253            throws PersistenceNotNullException, PersistenceReadOnlyException {
254        checkReadWrite();
255        _value.setSortOrder(sortOrder);
256    }
257    
258    public boolean getSortOrderHasBeenModified() {
259        return _value.getSortOrderHasBeenModified();
260    }
261    
262    public Long getFromTime() {
263        return _value.getFromTime();
264    }
265    
266    public void setFromTime(Long fromTime)
267            throws PersistenceNotNullException, PersistenceReadOnlyException {
268        checkReadWrite();
269        _value.setFromTime(fromTime);
270    }
271    
272    public boolean getFromTimeHasBeenModified() {
273        return _value.getFromTimeHasBeenModified();
274    }
275    
276    public Long getThruTime() {
277        return _value.getThruTime();
278    }
279    
280    public void setThruTime(Long thruTime)
281            throws PersistenceNotNullException, PersistenceReadOnlyException {
282        checkReadWrite();
283        _value.setThruTime(thruTime);
284    }
285    
286    public boolean getThruTimeHasBeenModified() {
287        return _value.getThruTimeHasBeenModified();
288    }
289    
290}