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
061import javax.annotation.Nonnull;
062import javax.annotation.Nullable;
063
064public class LetterContactMechanismPurposeDetail
065        extends BaseEntity
066        implements Serializable {
067    
068    private LetterContactMechanismPurposeDetailPK _pk;
069    private LetterContactMechanismPurposeDetailValue _value;
070    
071    /** Creates a new instance of LetterContactMechanismPurposeDetail */
072    public LetterContactMechanismPurposeDetail()
073            throws PersistenceException {
074        super();
075    }
076    
077    /** Creates a new instance of LetterContactMechanismPurposeDetail */
078    public LetterContactMechanismPurposeDetail(LetterContactMechanismPurposeDetailValue value, EntityPermission entityPermission) {
079        super(entityPermission);
080        
081        _value = value;
082        _pk = value.getPrimaryKey();
083    }
084    
085    @Override
086    @Nonnull
087    public LetterContactMechanismPurposeDetailFactory getBaseFactoryInstance() {
088        return LetterContactMechanismPurposeDetailFactory.getInstance();
089    }
090    
091    @Override
092    public boolean hasBeenModified() {
093        return _value.hasBeenModified();
094    }
095    
096    @Override
097    public int hashCode() {
098        return _pk.hashCode();
099    }
100    
101    @Override
102    @Nonnull
103    public String toString() {
104        return _pk.toString();
105    }
106    
107    @Override
108    public boolean equals(Object other) {
109        if(this == other)
110            return true;
111        
112        if(other instanceof LetterContactMechanismPurposeDetail that) {
113            LetterContactMechanismPurposeDetailValue thatValue = that.getLetterContactMechanismPurposeDetailValue();
114            return _value.equals(thatValue);
115        } else {
116            return false;
117        }
118    }
119    
120    @Override
121    public void store()
122            throws PersistenceDatabaseException {
123        getBaseFactoryInstance().store(this);
124    }
125    
126    @Override
127    public void remove()
128            throws PersistenceDatabaseException {
129        getBaseFactoryInstance().remove(this);
130    }
131    
132    @Nonnull
133    public LetterContactMechanismPurposeDetailValue getLetterContactMechanismPurposeDetailValue() {
134        return _value;
135    }
136    
137    public void setLetterContactMechanismPurposeDetailValue(@Nonnull LetterContactMechanismPurposeDetailValue value)
138            throws PersistenceReadOnlyException {
139        checkReadWrite();
140        _value = value;
141    }
142    
143    @Override
144    @Nonnull
145    public LetterContactMechanismPurposeDetailPK getPrimaryKey() {
146        return _pk;
147    }
148    
149    @Nonnull
150    public LetterContactMechanismPurposePK getLetterContactMechanismPurposePK() {
151        return _value.getLetterContactMechanismPurposePK();
152    }
153    
154    @Nonnull
155    public LetterContactMechanismPurpose getLetterContactMechanismPurpose(EntityPermission entityPermission) {
156        return LetterContactMechanismPurposeFactory.getInstance().getEntityFromPK(entityPermission, getLetterContactMechanismPurposePK());
157    }
158    
159    @Nonnull
160    public LetterContactMechanismPurpose getLetterContactMechanismPurpose() {
161        return getLetterContactMechanismPurpose(EntityPermission.READ_ONLY);
162    }
163    
164    @Nonnull
165    public LetterContactMechanismPurpose getLetterContactMechanismPurposeForUpdate() {
166        return getLetterContactMechanismPurpose(EntityPermission.READ_WRITE);
167    }
168    
169    public void setLetterContactMechanismPurposePK(@Nonnull LetterContactMechanismPurposePK letterContactMechanismPurposePK)
170            throws PersistenceNotNullException, PersistenceReadOnlyException {
171        checkReadWrite();
172        _value.setLetterContactMechanismPurposePK(letterContactMechanismPurposePK);
173    }
174    
175    public void setLetterContactMechanismPurpose(@Nonnull LetterContactMechanismPurpose entity) {
176        setLetterContactMechanismPurposePK(entity == null ? null : entity.getPrimaryKey());
177    }
178    
179    public boolean getLetterContactMechanismPurposePKHasBeenModified() {
180        return _value.getLetterContactMechanismPurposePKHasBeenModified();
181    }
182    
183    @Nonnull
184    public LetterPK getLetterPK() {
185        return _value.getLetterPK();
186    }
187    
188    @Nonnull
189    public Letter getLetter(EntityPermission entityPermission) {
190        return LetterFactory.getInstance().getEntityFromPK(entityPermission, getLetterPK());
191    }
192    
193    @Nonnull
194    public Letter getLetter() {
195        return getLetter(EntityPermission.READ_ONLY);
196    }
197    
198    @Nonnull
199    public Letter getLetterForUpdate() {
200        return getLetter(EntityPermission.READ_WRITE);
201    }
202    
203    public void setLetterPK(@Nonnull LetterPK letterPK)
204            throws PersistenceNotNullException, PersistenceReadOnlyException {
205        checkReadWrite();
206        _value.setLetterPK(letterPK);
207    }
208    
209    public void setLetter(@Nonnull Letter entity) {
210        setLetterPK(entity == null ? null : entity.getPrimaryKey());
211    }
212    
213    public boolean getLetterPKHasBeenModified() {
214        return _value.getLetterPKHasBeenModified();
215    }
216    
217    @Nonnull
218    public Integer getPriority() {
219        return _value.getPriority();
220    }
221    
222    public void setPriority(@Nonnull Integer priority)
223            throws PersistenceNotNullException, PersistenceReadOnlyException {
224        checkReadWrite();
225        _value.setPriority(priority);
226    }
227    
228    public boolean getPriorityHasBeenModified() {
229        return _value.getPriorityHasBeenModified();
230    }
231    
232    @Nonnull
233    public ContactMechanismPurposePK getContactMechanismPurposePK() {
234        return _value.getContactMechanismPurposePK();
235    }
236    
237    @Nonnull
238    public ContactMechanismPurpose getContactMechanismPurpose(EntityPermission entityPermission) {
239        return ContactMechanismPurposeFactory.getInstance().getEntityFromPK(entityPermission, getContactMechanismPurposePK());
240    }
241    
242    @Nonnull
243    public ContactMechanismPurpose getContactMechanismPurpose() {
244        return getContactMechanismPurpose(EntityPermission.READ_ONLY);
245    }
246    
247    @Nonnull
248    public ContactMechanismPurpose getContactMechanismPurposeForUpdate() {
249        return getContactMechanismPurpose(EntityPermission.READ_WRITE);
250    }
251    
252    public void setContactMechanismPurposePK(@Nonnull ContactMechanismPurposePK contactMechanismPurposePK)
253            throws PersistenceNotNullException, PersistenceReadOnlyException {
254        checkReadWrite();
255        _value.setContactMechanismPurposePK(contactMechanismPurposePK);
256    }
257    
258    public void setContactMechanismPurpose(@Nonnull ContactMechanismPurpose entity) {
259        setContactMechanismPurposePK(entity == null ? null : entity.getPrimaryKey());
260    }
261    
262    public boolean getContactMechanismPurposePKHasBeenModified() {
263        return _value.getContactMechanismPurposePKHasBeenModified();
264    }
265    
266    @Nonnull
267    public Long getFromTime() {
268        return _value.getFromTime();
269    }
270    
271    public void setFromTime(@Nonnull Long fromTime)
272            throws PersistenceNotNullException, PersistenceReadOnlyException {
273        checkReadWrite();
274        _value.setFromTime(fromTime);
275    }
276    
277    public boolean getFromTimeHasBeenModified() {
278        return _value.getFromTimeHasBeenModified();
279    }
280    
281    @Nonnull
282    public Long getThruTime() {
283        return _value.getThruTime();
284    }
285    
286    public void setThruTime(@Nonnull Long thruTime)
287            throws PersistenceNotNullException, PersistenceReadOnlyException {
288        checkReadWrite();
289        _value.setThruTime(thruTime);
290    }
291    
292    public boolean getThruTimeHasBeenModified() {
293        return _value.getThruTimeHasBeenModified();
294    }
295    
296}