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 * ForumMessageRole.java
021 */
022
023package com.echothree.model.data.forum.server.entity;
024
025import com.echothree.model.data.forum.common.pk.ForumMessageRolePK;
026
027import com.echothree.model.data.forum.common.pk.ForumMessagePK;
028import com.echothree.model.data.forum.common.pk.ForumRoleTypePK;
029import com.echothree.model.data.party.common.pk.PartyPK;
030
031import com.echothree.model.data.forum.server.entity.ForumMessage;
032import com.echothree.model.data.forum.server.entity.ForumRoleType;
033import com.echothree.model.data.party.server.entity.Party;
034
035import com.echothree.model.data.forum.server.factory.ForumMessageFactory;
036import com.echothree.model.data.forum.server.factory.ForumRoleTypeFactory;
037import com.echothree.model.data.party.server.factory.PartyFactory;
038
039import com.echothree.model.data.forum.common.pk.ForumMessageRolePK;
040
041import com.echothree.model.data.forum.server.value.ForumMessageRoleValue;
042
043import com.echothree.model.data.forum.server.factory.ForumMessageRoleFactory;
044
045import com.echothree.util.common.exception.PersistenceException;
046import com.echothree.util.common.exception.PersistenceDatabaseException;
047import com.echothree.util.common.exception.PersistenceNotNullException;
048import com.echothree.util.common.exception.PersistenceReadOnlyException;
049
050import com.echothree.util.common.persistence.BasePK;
051
052import com.echothree.util.common.persistence.type.ByteArray;
053
054import com.echothree.util.server.persistence.BaseEntity;
055import com.echothree.util.server.persistence.EntityPermission;
056import com.echothree.util.server.persistence.Session;
057import com.echothree.util.server.persistence.ThreadSession;
058
059import java.io.Serializable;
060
061public class ForumMessageRole
062        extends BaseEntity
063        implements Serializable {
064    
065    private ForumMessageRolePK _pk;
066    private ForumMessageRoleValue _value;
067    
068    /** Creates a new instance of ForumMessageRole */
069    public ForumMessageRole()
070            throws PersistenceException {
071        super();
072    }
073    
074    /** Creates a new instance of ForumMessageRole */
075    public ForumMessageRole(ForumMessageRoleValue value, EntityPermission entityPermission) {
076        super(entityPermission);
077        
078        _value = value;
079        _pk = value.getPrimaryKey();
080    }
081    
082    @Override
083    public ForumMessageRoleFactory getBaseFactoryInstance() {
084        return ForumMessageRoleFactory.getInstance();
085    }
086    
087    @Override
088    public boolean hasBeenModified() {
089        return _value.hasBeenModified();
090    }
091    
092    @Override
093    public int hashCode() {
094        return _pk.hashCode();
095    }
096    
097    @Override
098    public String toString() {
099        return _pk.toString();
100    }
101    
102    @Override
103    public boolean equals(Object other) {
104        if(this == other)
105            return true;
106        
107        if(other instanceof ForumMessageRole that) {
108            ForumMessageRoleValue thatValue = that.getForumMessageRoleValue();
109            return _value.equals(thatValue);
110        } else {
111            return false;
112        }
113    }
114    
115    @Override
116    public void store()
117            throws PersistenceDatabaseException {
118        getBaseFactoryInstance().store(this);
119    }
120    
121    @Override
122    public void remove()
123            throws PersistenceDatabaseException {
124        getBaseFactoryInstance().remove(this);
125    }
126    
127    public ForumMessageRoleValue getForumMessageRoleValue() {
128        return _value;
129    }
130    
131    public void setForumMessageRoleValue(ForumMessageRoleValue value)
132            throws PersistenceReadOnlyException {
133        checkReadWrite();
134        _value = value;
135    }
136    
137    @Override
138    public ForumMessageRolePK getPrimaryKey() {
139        return _pk;
140    }
141    
142    public ForumMessagePK getForumMessagePK() {
143        return _value.getForumMessagePK();
144    }
145    
146    public ForumMessage getForumMessage(EntityPermission entityPermission) {
147        return ForumMessageFactory.getInstance().getEntityFromPK(entityPermission, getForumMessagePK());
148    }
149    
150    public ForumMessage getForumMessage() {
151        return getForumMessage(EntityPermission.READ_ONLY);
152    }
153    
154    public ForumMessage getForumMessageForUpdate() {
155        return getForumMessage(EntityPermission.READ_WRITE);
156    }
157    
158    public void setForumMessagePK(ForumMessagePK forumMessagePK)
159            throws PersistenceNotNullException, PersistenceReadOnlyException {
160        checkReadWrite();
161        _value.setForumMessagePK(forumMessagePK);
162    }
163    
164    public void setForumMessage(ForumMessage entity) {
165        setForumMessagePK(entity == null? null: entity.getPrimaryKey());
166    }
167    
168    public boolean getForumMessagePKHasBeenModified() {
169        return _value.getForumMessagePKHasBeenModified();
170    }
171    
172    public ForumRoleTypePK getForumRoleTypePK() {
173        return _value.getForumRoleTypePK();
174    }
175    
176    public ForumRoleType getForumRoleType(EntityPermission entityPermission) {
177        return ForumRoleTypeFactory.getInstance().getEntityFromPK(entityPermission, getForumRoleTypePK());
178    }
179    
180    public ForumRoleType getForumRoleType() {
181        return getForumRoleType(EntityPermission.READ_ONLY);
182    }
183    
184    public ForumRoleType getForumRoleTypeForUpdate() {
185        return getForumRoleType(EntityPermission.READ_WRITE);
186    }
187    
188    public void setForumRoleTypePK(ForumRoleTypePK forumRoleTypePK)
189            throws PersistenceNotNullException, PersistenceReadOnlyException {
190        checkReadWrite();
191        _value.setForumRoleTypePK(forumRoleTypePK);
192    }
193    
194    public void setForumRoleType(ForumRoleType entity) {
195        setForumRoleTypePK(entity == null? null: entity.getPrimaryKey());
196    }
197    
198    public boolean getForumRoleTypePKHasBeenModified() {
199        return _value.getForumRoleTypePKHasBeenModified();
200    }
201    
202    public PartyPK getPartyPK() {
203        return _value.getPartyPK();
204    }
205    
206    public Party getParty(EntityPermission entityPermission) {
207        return PartyFactory.getInstance().getEntityFromPK(entityPermission, getPartyPK());
208    }
209    
210    public Party getParty() {
211        return getParty(EntityPermission.READ_ONLY);
212    }
213    
214    public Party getPartyForUpdate() {
215        return getParty(EntityPermission.READ_WRITE);
216    }
217    
218    public void setPartyPK(PartyPK partyPK)
219            throws PersistenceNotNullException, PersistenceReadOnlyException {
220        checkReadWrite();
221        _value.setPartyPK(partyPK);
222    }
223    
224    public void setParty(Party entity) {
225        setPartyPK(entity == null? null: entity.getPrimaryKey());
226    }
227    
228    public boolean getPartyPKHasBeenModified() {
229        return _value.getPartyPKHasBeenModified();
230    }
231    
232    public Long getFromTime() {
233        return _value.getFromTime();
234    }
235    
236    public void setFromTime(Long fromTime)
237            throws PersistenceNotNullException, PersistenceReadOnlyException {
238        checkReadWrite();
239        _value.setFromTime(fromTime);
240    }
241    
242    public boolean getFromTimeHasBeenModified() {
243        return _value.getFromTimeHasBeenModified();
244    }
245    
246    public Long getThruTime() {
247        return _value.getThruTime();
248    }
249    
250    public void setThruTime(Long thruTime)
251            throws PersistenceNotNullException, PersistenceReadOnlyException {
252        checkReadWrite();
253        _value.setThruTime(thruTime);
254    }
255    
256    public boolean getThruTimeHasBeenModified() {
257        return _value.getThruTimeHasBeenModified();
258    }
259    
260}