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 * 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) {
105            MessageDetail that = (MessageDetail)other;
106            
107            MessageDetailValue thatValue = that.getMessageDetailValue();
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 MessageDetailValue getMessageDetailValue() {
133        return _value;
134    }
135    
136    public void setMessageDetailValue(MessageDetailValue value)
137            throws PersistenceReadOnlyException {
138        checkReadWrite();
139        _value = value;
140    }
141    
142    @Override
143    public MessageDetailPK getPrimaryKey() {
144        return _pk;
145    }
146    
147    public MessagePK getMessagePK() {
148        return _value.getMessagePK();
149    }
150    
151    public Message getMessage(Session session, EntityPermission entityPermission) {
152        return MessageFactory.getInstance().getEntityFromPK(session, entityPermission, getMessagePK());
153    }
154    
155    public Message getMessage(EntityPermission entityPermission) {
156        return getMessage(ThreadSession.currentSession(), entityPermission);
157    }
158    
159    public Message getMessage(Session session) {
160        return getMessage(session, EntityPermission.READ_ONLY);
161    }
162    
163    public Message getMessage() {
164        return getMessage(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
165    }
166    
167    public Message getMessageForUpdate(Session session) {
168        return getMessage(session, EntityPermission.READ_WRITE);
169    }
170    
171    public Message getMessageForUpdate() {
172        return getMessage(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
173    }
174    
175    public void setMessagePK(MessagePK messagePK)
176            throws PersistenceNotNullException, PersistenceReadOnlyException {
177        checkReadWrite();
178        _value.setMessagePK(messagePK);
179    }
180    
181    public void setMessage(Message entity) {
182        setMessagePK(entity == null? null: entity.getPrimaryKey());
183    }
184    
185    public boolean getMessagePKHasBeenModified() {
186        return _value.getMessagePKHasBeenModified();
187    }
188    
189    public MessageTypePK getMessageTypePK() {
190        return _value.getMessageTypePK();
191    }
192    
193    public MessageType getMessageType(Session session, EntityPermission entityPermission) {
194        return MessageTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getMessageTypePK());
195    }
196    
197    public MessageType getMessageType(EntityPermission entityPermission) {
198        return getMessageType(ThreadSession.currentSession(), entityPermission);
199    }
200    
201    public MessageType getMessageType(Session session) {
202        return getMessageType(session, EntityPermission.READ_ONLY);
203    }
204    
205    public MessageType getMessageType() {
206        return getMessageType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
207    }
208    
209    public MessageType getMessageTypeForUpdate(Session session) {
210        return getMessageType(session, EntityPermission.READ_WRITE);
211    }
212    
213    public MessageType getMessageTypeForUpdate() {
214        return getMessageType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
215    }
216    
217    public void setMessageTypePK(MessageTypePK messageTypePK)
218            throws PersistenceNotNullException, PersistenceReadOnlyException {
219        checkReadWrite();
220        _value.setMessageTypePK(messageTypePK);
221    }
222    
223    public void setMessageType(MessageType entity) {
224        setMessageTypePK(entity == null? null: entity.getPrimaryKey());
225    }
226    
227    public boolean getMessageTypePKHasBeenModified() {
228        return _value.getMessageTypePKHasBeenModified();
229    }
230    
231    public String getMessageName() {
232        return _value.getMessageName();
233    }
234    
235    public void setMessageName(String messageName)
236            throws PersistenceNotNullException, PersistenceReadOnlyException {
237        checkReadWrite();
238        _value.setMessageName(messageName);
239    }
240    
241    public boolean getMessageNameHasBeenModified() {
242        return _value.getMessageNameHasBeenModified();
243    }
244    
245    public Boolean getIncludeByDefault() {
246        return _value.getIncludeByDefault();
247    }
248    
249    public void setIncludeByDefault(Boolean includeByDefault)
250            throws PersistenceNotNullException, PersistenceReadOnlyException {
251        checkReadWrite();
252        _value.setIncludeByDefault(includeByDefault);
253    }
254    
255    public boolean getIncludeByDefaultHasBeenModified() {
256        return _value.getIncludeByDefaultHasBeenModified();
257    }
258    
259    public Boolean getIsDefault() {
260        return _value.getIsDefault();
261    }
262    
263    public void setIsDefault(Boolean isDefault)
264            throws PersistenceNotNullException, PersistenceReadOnlyException {
265        checkReadWrite();
266        _value.setIsDefault(isDefault);
267    }
268    
269    public boolean getIsDefaultHasBeenModified() {
270        return _value.getIsDefaultHasBeenModified();
271    }
272    
273    public Integer getSortOrder() {
274        return _value.getSortOrder();
275    }
276    
277    public void setSortOrder(Integer sortOrder)
278            throws PersistenceNotNullException, PersistenceReadOnlyException {
279        checkReadWrite();
280        _value.setSortOrder(sortOrder);
281    }
282    
283    public boolean getSortOrderHasBeenModified() {
284        return _value.getSortOrderHasBeenModified();
285    }
286    
287    public Long getFromTime() {
288        return _value.getFromTime();
289    }
290    
291    public void setFromTime(Long fromTime)
292            throws PersistenceNotNullException, PersistenceReadOnlyException {
293        checkReadWrite();
294        _value.setFromTime(fromTime);
295    }
296    
297    public boolean getFromTimeHasBeenModified() {
298        return _value.getFromTimeHasBeenModified();
299    }
300    
301    public Long getThruTime() {
302        return _value.getThruTime();
303    }
304    
305    public void setThruTime(Long thruTime)
306            throws PersistenceNotNullException, PersistenceReadOnlyException {
307        checkReadWrite();
308        _value.setThruTime(thruTime);
309    }
310    
311    public boolean getThruTimeHasBeenModified() {
312        return _value.getThruTimeHasBeenModified();
313    }
314    
315}