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