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 * 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()
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 LetterContactMechanismPurposeDetailValue getLetterContactMechanismPurposeDetailValue() {
128        return _value;
129    }
130    
131    public void setLetterContactMechanismPurposeDetailValue(LetterContactMechanismPurposeDetailValue value)
132            throws PersistenceReadOnlyException {
133        checkReadWrite();
134        _value = value;
135    }
136    
137    @Override
138    public LetterContactMechanismPurposeDetailPK getPrimaryKey() {
139        return _pk;
140    }
141    
142    public LetterContactMechanismPurposePK getLetterContactMechanismPurposePK() {
143        return _value.getLetterContactMechanismPurposePK();
144    }
145    
146    public LetterContactMechanismPurpose getLetterContactMechanismPurpose(EntityPermission entityPermission) {
147        return LetterContactMechanismPurposeFactory.getInstance().getEntityFromPK(entityPermission, getLetterContactMechanismPurposePK());
148    }
149    
150    public LetterContactMechanismPurpose getLetterContactMechanismPurpose() {
151        return getLetterContactMechanismPurpose(EntityPermission.READ_ONLY);
152    }
153    
154    public LetterContactMechanismPurpose getLetterContactMechanismPurposeForUpdate() {
155        return getLetterContactMechanismPurpose(EntityPermission.READ_WRITE);
156    }
157    
158    public void setLetterContactMechanismPurposePK(LetterContactMechanismPurposePK letterContactMechanismPurposePK)
159            throws PersistenceNotNullException, PersistenceReadOnlyException {
160        checkReadWrite();
161        _value.setLetterContactMechanismPurposePK(letterContactMechanismPurposePK);
162    }
163    
164    public void setLetterContactMechanismPurpose(LetterContactMechanismPurpose entity) {
165        setLetterContactMechanismPurposePK(entity == null? null: entity.getPrimaryKey());
166    }
167    
168    public boolean getLetterContactMechanismPurposePKHasBeenModified() {
169        return _value.getLetterContactMechanismPurposePKHasBeenModified();
170    }
171    
172    public LetterPK getLetterPK() {
173        return _value.getLetterPK();
174    }
175    
176    public Letter getLetter(EntityPermission entityPermission) {
177        return LetterFactory.getInstance().getEntityFromPK(entityPermission, getLetterPK());
178    }
179    
180    public Letter getLetter() {
181        return getLetter(EntityPermission.READ_ONLY);
182    }
183    
184    public Letter getLetterForUpdate() {
185        return getLetter(EntityPermission.READ_WRITE);
186    }
187    
188    public void setLetterPK(LetterPK letterPK)
189            throws PersistenceNotNullException, PersistenceReadOnlyException {
190        checkReadWrite();
191        _value.setLetterPK(letterPK);
192    }
193    
194    public void setLetter(Letter entity) {
195        setLetterPK(entity == null? null: entity.getPrimaryKey());
196    }
197    
198    public boolean getLetterPKHasBeenModified() {
199        return _value.getLetterPKHasBeenModified();
200    }
201    
202    public Integer getPriority() {
203        return _value.getPriority();
204    }
205    
206    public void setPriority(Integer priority)
207            throws PersistenceNotNullException, PersistenceReadOnlyException {
208        checkReadWrite();
209        _value.setPriority(priority);
210    }
211    
212    public boolean getPriorityHasBeenModified() {
213        return _value.getPriorityHasBeenModified();
214    }
215    
216    public ContactMechanismPurposePK getContactMechanismPurposePK() {
217        return _value.getContactMechanismPurposePK();
218    }
219    
220    public ContactMechanismPurpose getContactMechanismPurpose(EntityPermission entityPermission) {
221        return ContactMechanismPurposeFactory.getInstance().getEntityFromPK(entityPermission, getContactMechanismPurposePK());
222    }
223    
224    public ContactMechanismPurpose getContactMechanismPurpose() {
225        return getContactMechanismPurpose(EntityPermission.READ_ONLY);
226    }
227    
228    public ContactMechanismPurpose getContactMechanismPurposeForUpdate() {
229        return getContactMechanismPurpose(EntityPermission.READ_WRITE);
230    }
231    
232    public void setContactMechanismPurposePK(ContactMechanismPurposePK contactMechanismPurposePK)
233            throws PersistenceNotNullException, PersistenceReadOnlyException {
234        checkReadWrite();
235        _value.setContactMechanismPurposePK(contactMechanismPurposePK);
236    }
237    
238    public void setContactMechanismPurpose(ContactMechanismPurpose entity) {
239        setContactMechanismPurposePK(entity == null? null: entity.getPrimaryKey());
240    }
241    
242    public boolean getContactMechanismPurposePKHasBeenModified() {
243        return _value.getContactMechanismPurposePKHasBeenModified();
244    }
245    
246    public Long getFromTime() {
247        return _value.getFromTime();
248    }
249    
250    public void setFromTime(Long fromTime)
251            throws PersistenceNotNullException, PersistenceReadOnlyException {
252        checkReadWrite();
253        _value.setFromTime(fromTime);
254    }
255    
256    public boolean getFromTimeHasBeenModified() {
257        return _value.getFromTimeHasBeenModified();
258    }
259    
260    public Long getThruTime() {
261        return _value.getThruTime();
262    }
263    
264    public void setThruTime(Long thruTime)
265            throws PersistenceNotNullException, PersistenceReadOnlyException {
266        checkReadWrite();
267        _value.setThruTime(thruTime);
268    }
269    
270    public boolean getThruTimeHasBeenModified() {
271        return _value.getThruTimeHasBeenModified();
272    }
273    
274}