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 * MessageDetail.java
021 */
022
023package com.echothree.model.data.message.server.entity;
024
025import com.echothree.model.data.message.common.pk.MessageDetailPK;
026
027import com.echothree.model.data.message.common.pk.MessagePK;
028import com.echothree.model.data.message.common.pk.MessageTypePK;
029
030import com.echothree.model.data.message.server.entity.Message;
031import com.echothree.model.data.message.server.entity.MessageType;
032
033import com.echothree.model.data.message.server.factory.MessageFactory;
034import com.echothree.model.data.message.server.factory.MessageTypeFactory;
035
036import com.echothree.model.data.message.common.pk.MessageDetailPK;
037
038import com.echothree.model.data.message.server.value.MessageDetailValue;
039
040import com.echothree.model.data.message.server.factory.MessageDetailFactory;
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 MessageDetail
059        extends BaseEntity
060        implements Serializable {
061    
062    private MessageDetailPK _pk;
063    private MessageDetailValue _value;
064    
065    /** Creates a new instance of MessageDetail */
066    public MessageDetail()
067            throws PersistenceException {
068        super();
069    }
070    
071    /** Creates a new instance of MessageDetail */
072    public MessageDetail(MessageDetailValue value, EntityPermission entityPermission) {
073        super(entityPermission);
074        
075        _value = value;
076        _pk = value.getPrimaryKey();
077    }
078    
079    @Override
080    public MessageDetailFactory getBaseFactoryInstance() {
081        return MessageDetailFactory.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 MessageDetail that) {
105            MessageDetailValue thatValue = that.getMessageDetailValue();
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 MessageDetailValue getMessageDetailValue() {
131        return _value;
132    }
133    
134    public void setMessageDetailValue(MessageDetailValue value)
135            throws PersistenceReadOnlyException {
136        checkReadWrite();
137        _value = value;
138    }
139    
140    @Override
141    public MessageDetailPK getPrimaryKey() {
142        return _pk;
143    }
144    
145    public MessagePK getMessagePK() {
146        return _value.getMessagePK();
147    }
148    
149    public Message getMessage(Session session, EntityPermission entityPermission) {
150        return MessageFactory.getInstance().getEntityFromPK(session, entityPermission, getMessagePK());
151    }
152    
153    public Message getMessage(EntityPermission entityPermission) {
154        return getMessage(ThreadSession.currentSession(), entityPermission);
155    }
156    
157    public Message getMessage(Session session) {
158        return getMessage(session, EntityPermission.READ_ONLY);
159    }
160    
161    public Message getMessage() {
162        return getMessage(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
163    }
164    
165    public Message getMessageForUpdate(Session session) {
166        return getMessage(session, EntityPermission.READ_WRITE);
167    }
168    
169    public Message getMessageForUpdate() {
170        return getMessage(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
171    }
172    
173    public void setMessagePK(MessagePK messagePK)
174            throws PersistenceNotNullException, PersistenceReadOnlyException {
175        checkReadWrite();
176        _value.setMessagePK(messagePK);
177    }
178    
179    public void setMessage(Message entity) {
180        setMessagePK(entity == null? null: entity.getPrimaryKey());
181    }
182    
183    public boolean getMessagePKHasBeenModified() {
184        return _value.getMessagePKHasBeenModified();
185    }
186    
187    public MessageTypePK getMessageTypePK() {
188        return _value.getMessageTypePK();
189    }
190    
191    public MessageType getMessageType(Session session, EntityPermission entityPermission) {
192        return MessageTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getMessageTypePK());
193    }
194    
195    public MessageType getMessageType(EntityPermission entityPermission) {
196        return getMessageType(ThreadSession.currentSession(), entityPermission);
197    }
198    
199    public MessageType getMessageType(Session session) {
200        return getMessageType(session, EntityPermission.READ_ONLY);
201    }
202    
203    public MessageType getMessageType() {
204        return getMessageType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
205    }
206    
207    public MessageType getMessageTypeForUpdate(Session session) {
208        return getMessageType(session, EntityPermission.READ_WRITE);
209    }
210    
211    public MessageType getMessageTypeForUpdate() {
212        return getMessageType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
213    }
214    
215    public void setMessageTypePK(MessageTypePK messageTypePK)
216            throws PersistenceNotNullException, PersistenceReadOnlyException {
217        checkReadWrite();
218        _value.setMessageTypePK(messageTypePK);
219    }
220    
221    public void setMessageType(MessageType entity) {
222        setMessageTypePK(entity == null? null: entity.getPrimaryKey());
223    }
224    
225    public boolean getMessageTypePKHasBeenModified() {
226        return _value.getMessageTypePKHasBeenModified();
227    }
228    
229    public String getMessageName() {
230        return _value.getMessageName();
231    }
232    
233    public void setMessageName(String messageName)
234            throws PersistenceNotNullException, PersistenceReadOnlyException {
235        checkReadWrite();
236        _value.setMessageName(messageName);
237    }
238    
239    public boolean getMessageNameHasBeenModified() {
240        return _value.getMessageNameHasBeenModified();
241    }
242    
243    public Boolean getIncludeByDefault() {
244        return _value.getIncludeByDefault();
245    }
246    
247    public void setIncludeByDefault(Boolean includeByDefault)
248            throws PersistenceNotNullException, PersistenceReadOnlyException {
249        checkReadWrite();
250        _value.setIncludeByDefault(includeByDefault);
251    }
252    
253    public boolean getIncludeByDefaultHasBeenModified() {
254        return _value.getIncludeByDefaultHasBeenModified();
255    }
256    
257    public Boolean getIsDefault() {
258        return _value.getIsDefault();
259    }
260    
261    public void setIsDefault(Boolean isDefault)
262            throws PersistenceNotNullException, PersistenceReadOnlyException {
263        checkReadWrite();
264        _value.setIsDefault(isDefault);
265    }
266    
267    public boolean getIsDefaultHasBeenModified() {
268        return _value.getIsDefaultHasBeenModified();
269    }
270    
271    public Integer getSortOrder() {
272        return _value.getSortOrder();
273    }
274    
275    public void setSortOrder(Integer sortOrder)
276            throws PersistenceNotNullException, PersistenceReadOnlyException {
277        checkReadWrite();
278        _value.setSortOrder(sortOrder);
279    }
280    
281    public boolean getSortOrderHasBeenModified() {
282        return _value.getSortOrderHasBeenModified();
283    }
284    
285    public Long getFromTime() {
286        return _value.getFromTime();
287    }
288    
289    public void setFromTime(Long fromTime)
290            throws PersistenceNotNullException, PersistenceReadOnlyException {
291        checkReadWrite();
292        _value.setFromTime(fromTime);
293    }
294    
295    public boolean getFromTimeHasBeenModified() {
296        return _value.getFromTimeHasBeenModified();
297    }
298    
299    public Long getThruTime() {
300        return _value.getThruTime();
301    }
302    
303    public void setThruTime(Long thruTime)
304            throws PersistenceNotNullException, PersistenceReadOnlyException {
305        checkReadWrite();
306        _value.setThruTime(thruTime);
307    }
308    
309    public boolean getThruTimeHasBeenModified() {
310        return _value.getThruTimeHasBeenModified();
311    }
312    
313}