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 * LetterContactMechanismPurposeDetail.java
021 */
022
023package com.echothree.model.data.letter.server.entity;
024
025import com.echothree.model.data.letter.common.pk.LetterContactMechanismPurposeDetailPK;
026
027import com.echothree.model.data.letter.common.pk.LetterContactMechanismPurposePK;
028import com.echothree.model.data.letter.common.pk.LetterPK;
029import com.echothree.model.data.contact.common.pk.ContactMechanismPurposePK;
030
031import com.echothree.model.data.letter.server.entity.LetterContactMechanismPurpose;
032import com.echothree.model.data.letter.server.entity.Letter;
033import com.echothree.model.data.contact.server.entity.ContactMechanismPurpose;
034
035import com.echothree.model.data.letter.server.factory.LetterContactMechanismPurposeFactory;
036import com.echothree.model.data.letter.server.factory.LetterFactory;
037import com.echothree.model.data.contact.server.factory.ContactMechanismPurposeFactory;
038
039import com.echothree.model.data.letter.common.pk.LetterContactMechanismPurposeDetailPK;
040
041import com.echothree.model.data.letter.server.value.LetterContactMechanismPurposeDetailValue;
042
043import com.echothree.model.data.letter.server.factory.LetterContactMechanismPurposeDetailFactory;
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 LetterContactMechanismPurposeDetail
062        extends BaseEntity
063        implements Serializable {
064    
065    private LetterContactMechanismPurposeDetailPK _pk;
066    private LetterContactMechanismPurposeDetailValue _value;
067    
068    /** Creates a new instance of LetterContactMechanismPurposeDetail */
069    public LetterContactMechanismPurposeDetail()
070            throws PersistenceException {
071        super();
072    }
073    
074    /** Creates a new instance of LetterContactMechanismPurposeDetail */
075    public LetterContactMechanismPurposeDetail(LetterContactMechanismPurposeDetailValue value, EntityPermission entityPermission) {
076        super(entityPermission);
077        
078        _value = value;
079        _pk = value.getPrimaryKey();
080    }
081    
082    @Override
083    public LetterContactMechanismPurposeDetailFactory getBaseFactoryInstance() {
084        return LetterContactMechanismPurposeDetailFactory.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 LetterContactMechanismPurposeDetail) {
108            LetterContactMechanismPurposeDetail that = (LetterContactMechanismPurposeDetail)other;
109            
110            LetterContactMechanismPurposeDetailValue thatValue = that.getLetterContactMechanismPurposeDetailValue();
111            return _value.equals(thatValue);
112        } else {
113            return false;
114        }
115    }
116    
117    @Override
118    public void store(Session session)
119            throws PersistenceDatabaseException {
120        getBaseFactoryInstance().store(session, this);
121    }
122    
123    @Override
124    public void remove(Session session)
125            throws PersistenceDatabaseException {
126        getBaseFactoryInstance().remove(session, this);
127    }
128    
129    @Override
130    public void remove()
131            throws PersistenceDatabaseException {
132        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
133    }
134    
135    public LetterContactMechanismPurposeDetailValue getLetterContactMechanismPurposeDetailValue() {
136        return _value;
137    }
138    
139    public void setLetterContactMechanismPurposeDetailValue(LetterContactMechanismPurposeDetailValue value)
140            throws PersistenceReadOnlyException {
141        checkReadWrite();
142        _value = value;
143    }
144    
145    @Override
146    public LetterContactMechanismPurposeDetailPK getPrimaryKey() {
147        return _pk;
148    }
149    
150    public LetterContactMechanismPurposePK getLetterContactMechanismPurposePK() {
151        return _value.getLetterContactMechanismPurposePK();
152    }
153    
154    public LetterContactMechanismPurpose getLetterContactMechanismPurpose(Session session, EntityPermission entityPermission) {
155        return LetterContactMechanismPurposeFactory.getInstance().getEntityFromPK(session, entityPermission, getLetterContactMechanismPurposePK());
156    }
157    
158    public LetterContactMechanismPurpose getLetterContactMechanismPurpose(EntityPermission entityPermission) {
159        return getLetterContactMechanismPurpose(ThreadSession.currentSession(), entityPermission);
160    }
161    
162    public LetterContactMechanismPurpose getLetterContactMechanismPurpose(Session session) {
163        return getLetterContactMechanismPurpose(session, EntityPermission.READ_ONLY);
164    }
165    
166    public LetterContactMechanismPurpose getLetterContactMechanismPurpose() {
167        return getLetterContactMechanismPurpose(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
168    }
169    
170    public LetterContactMechanismPurpose getLetterContactMechanismPurposeForUpdate(Session session) {
171        return getLetterContactMechanismPurpose(session, EntityPermission.READ_WRITE);
172    }
173    
174    public LetterContactMechanismPurpose getLetterContactMechanismPurposeForUpdate() {
175        return getLetterContactMechanismPurpose(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
176    }
177    
178    public void setLetterContactMechanismPurposePK(LetterContactMechanismPurposePK letterContactMechanismPurposePK)
179            throws PersistenceNotNullException, PersistenceReadOnlyException {
180        checkReadWrite();
181        _value.setLetterContactMechanismPurposePK(letterContactMechanismPurposePK);
182    }
183    
184    public void setLetterContactMechanismPurpose(LetterContactMechanismPurpose entity) {
185        setLetterContactMechanismPurposePK(entity == null? null: entity.getPrimaryKey());
186    }
187    
188    public boolean getLetterContactMechanismPurposePKHasBeenModified() {
189        return _value.getLetterContactMechanismPurposePKHasBeenModified();
190    }
191    
192    public LetterPK getLetterPK() {
193        return _value.getLetterPK();
194    }
195    
196    public Letter getLetter(Session session, EntityPermission entityPermission) {
197        return LetterFactory.getInstance().getEntityFromPK(session, entityPermission, getLetterPK());
198    }
199    
200    public Letter getLetter(EntityPermission entityPermission) {
201        return getLetter(ThreadSession.currentSession(), entityPermission);
202    }
203    
204    public Letter getLetter(Session session) {
205        return getLetter(session, EntityPermission.READ_ONLY);
206    }
207    
208    public Letter getLetter() {
209        return getLetter(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
210    }
211    
212    public Letter getLetterForUpdate(Session session) {
213        return getLetter(session, EntityPermission.READ_WRITE);
214    }
215    
216    public Letter getLetterForUpdate() {
217        return getLetter(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
218    }
219    
220    public void setLetterPK(LetterPK letterPK)
221            throws PersistenceNotNullException, PersistenceReadOnlyException {
222        checkReadWrite();
223        _value.setLetterPK(letterPK);
224    }
225    
226    public void setLetter(Letter entity) {
227        setLetterPK(entity == null? null: entity.getPrimaryKey());
228    }
229    
230    public boolean getLetterPKHasBeenModified() {
231        return _value.getLetterPKHasBeenModified();
232    }
233    
234    public Integer getPriority() {
235        return _value.getPriority();
236    }
237    
238    public void setPriority(Integer priority)
239            throws PersistenceNotNullException, PersistenceReadOnlyException {
240        checkReadWrite();
241        _value.setPriority(priority);
242    }
243    
244    public boolean getPriorityHasBeenModified() {
245        return _value.getPriorityHasBeenModified();
246    }
247    
248    public ContactMechanismPurposePK getContactMechanismPurposePK() {
249        return _value.getContactMechanismPurposePK();
250    }
251    
252    public ContactMechanismPurpose getContactMechanismPurpose(Session session, EntityPermission entityPermission) {
253        return ContactMechanismPurposeFactory.getInstance().getEntityFromPK(session, entityPermission, getContactMechanismPurposePK());
254    }
255    
256    public ContactMechanismPurpose getContactMechanismPurpose(EntityPermission entityPermission) {
257        return getContactMechanismPurpose(ThreadSession.currentSession(), entityPermission);
258    }
259    
260    public ContactMechanismPurpose getContactMechanismPurpose(Session session) {
261        return getContactMechanismPurpose(session, EntityPermission.READ_ONLY);
262    }
263    
264    public ContactMechanismPurpose getContactMechanismPurpose() {
265        return getContactMechanismPurpose(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
266    }
267    
268    public ContactMechanismPurpose getContactMechanismPurposeForUpdate(Session session) {
269        return getContactMechanismPurpose(session, EntityPermission.READ_WRITE);
270    }
271    
272    public ContactMechanismPurpose getContactMechanismPurposeForUpdate() {
273        return getContactMechanismPurpose(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
274    }
275    
276    public void setContactMechanismPurposePK(ContactMechanismPurposePK contactMechanismPurposePK)
277            throws PersistenceNotNullException, PersistenceReadOnlyException {
278        checkReadWrite();
279        _value.setContactMechanismPurposePK(contactMechanismPurposePK);
280    }
281    
282    public void setContactMechanismPurpose(ContactMechanismPurpose entity) {
283        setContactMechanismPurposePK(entity == null? null: entity.getPrimaryKey());
284    }
285    
286    public boolean getContactMechanismPurposePKHasBeenModified() {
287        return _value.getContactMechanismPurposePKHasBeenModified();
288    }
289    
290    public Long getFromTime() {
291        return _value.getFromTime();
292    }
293    
294    public void setFromTime(Long fromTime)
295            throws PersistenceNotNullException, PersistenceReadOnlyException {
296        checkReadWrite();
297        _value.setFromTime(fromTime);
298    }
299    
300    public boolean getFromTimeHasBeenModified() {
301        return _value.getFromTimeHasBeenModified();
302    }
303    
304    public Long getThruTime() {
305        return _value.getThruTime();
306    }
307    
308    public void setThruTime(Long thruTime)
309            throws PersistenceNotNullException, PersistenceReadOnlyException {
310        checkReadWrite();
311        _value.setThruTime(thruTime);
312    }
313    
314    public boolean getThruTimeHasBeenModified() {
315        return _value.getThruTimeHasBeenModified();
316    }
317    
318}