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 * PartyContactListDetail.java
021 */
022
023package com.echothree.model.data.contactlist.server.entity;
024
025import com.echothree.model.data.contactlist.common.pk.PartyContactListDetailPK;
026
027import com.echothree.model.data.contactlist.common.pk.PartyContactListPK;
028import com.echothree.model.data.party.common.pk.PartyPK;
029import com.echothree.model.data.contactlist.common.pk.ContactListPK;
030import com.echothree.model.data.contactlist.common.pk.ContactListContactMechanismPurposePK;
031
032import com.echothree.model.data.contactlist.server.entity.PartyContactList;
033import com.echothree.model.data.party.server.entity.Party;
034import com.echothree.model.data.contactlist.server.entity.ContactList;
035import com.echothree.model.data.contactlist.server.entity.ContactListContactMechanismPurpose;
036
037import com.echothree.model.data.contactlist.server.factory.PartyContactListFactory;
038import com.echothree.model.data.party.server.factory.PartyFactory;
039import com.echothree.model.data.contactlist.server.factory.ContactListFactory;
040import com.echothree.model.data.contactlist.server.factory.ContactListContactMechanismPurposeFactory;
041
042import com.echothree.model.data.contactlist.common.pk.PartyContactListDetailPK;
043
044import com.echothree.model.data.contactlist.server.value.PartyContactListDetailValue;
045
046import com.echothree.model.data.contactlist.server.factory.PartyContactListDetailFactory;
047
048import com.echothree.util.common.exception.PersistenceException;
049import com.echothree.util.common.exception.PersistenceDatabaseException;
050import com.echothree.util.common.exception.PersistenceNotNullException;
051import com.echothree.util.common.exception.PersistenceReadOnlyException;
052
053import com.echothree.util.common.persistence.BasePK;
054
055import com.echothree.util.common.persistence.type.ByteArray;
056
057import com.echothree.util.server.persistence.BaseEntity;
058import com.echothree.util.server.persistence.EntityPermission;
059import com.echothree.util.server.persistence.Session;
060import com.echothree.util.server.persistence.ThreadSession;
061
062import java.io.Serializable;
063
064public class PartyContactListDetail
065        extends BaseEntity
066        implements Serializable {
067    
068    private PartyContactListDetailPK _pk;
069    private PartyContactListDetailValue _value;
070    
071    /** Creates a new instance of PartyContactListDetail */
072    public PartyContactListDetail()
073            throws PersistenceException {
074        super();
075    }
076    
077    /** Creates a new instance of PartyContactListDetail */
078    public PartyContactListDetail(PartyContactListDetailValue value, EntityPermission entityPermission) {
079        super(entityPermission);
080        
081        _value = value;
082        _pk = value.getPrimaryKey();
083    }
084    
085    @Override
086    public PartyContactListDetailFactory getBaseFactoryInstance() {
087        return PartyContactListDetailFactory.getInstance();
088    }
089    
090    @Override
091    public boolean hasBeenModified() {
092        return _value.hasBeenModified();
093    }
094    
095    @Override
096    public int hashCode() {
097        return _pk.hashCode();
098    }
099    
100    @Override
101    public String toString() {
102        return _pk.toString();
103    }
104    
105    @Override
106    public boolean equals(Object other) {
107        if(this == other)
108            return true;
109        
110        if(other instanceof PartyContactListDetail that) {
111            PartyContactListDetailValue thatValue = that.getPartyContactListDetailValue();
112            return _value.equals(thatValue);
113        } else {
114            return false;
115        }
116    }
117    
118    @Override
119    public void store()
120            throws PersistenceDatabaseException {
121        getBaseFactoryInstance().store(this);
122    }
123    
124    @Override
125    public void remove()
126            throws PersistenceDatabaseException {
127        getBaseFactoryInstance().remove(this);
128    }
129    
130    public PartyContactListDetailValue getPartyContactListDetailValue() {
131        return _value;
132    }
133    
134    public void setPartyContactListDetailValue(PartyContactListDetailValue value)
135            throws PersistenceReadOnlyException {
136        checkReadWrite();
137        _value = value;
138    }
139    
140    @Override
141    public PartyContactListDetailPK getPrimaryKey() {
142        return _pk;
143    }
144    
145    public PartyContactListPK getPartyContactListPK() {
146        return _value.getPartyContactListPK();
147    }
148    
149    public PartyContactList getPartyContactList(EntityPermission entityPermission) {
150        return PartyContactListFactory.getInstance().getEntityFromPK(entityPermission, getPartyContactListPK());
151    }
152    
153    public PartyContactList getPartyContactList() {
154        return getPartyContactList(EntityPermission.READ_ONLY);
155    }
156    
157    public PartyContactList getPartyContactListForUpdate() {
158        return getPartyContactList(EntityPermission.READ_WRITE);
159    }
160    
161    public void setPartyContactListPK(PartyContactListPK partyContactListPK)
162            throws PersistenceNotNullException, PersistenceReadOnlyException {
163        checkReadWrite();
164        _value.setPartyContactListPK(partyContactListPK);
165    }
166    
167    public void setPartyContactList(PartyContactList entity) {
168        setPartyContactListPK(entity == null? null: entity.getPrimaryKey());
169    }
170    
171    public boolean getPartyContactListPKHasBeenModified() {
172        return _value.getPartyContactListPKHasBeenModified();
173    }
174    
175    public PartyPK getPartyPK() {
176        return _value.getPartyPK();
177    }
178    
179    public Party getParty(EntityPermission entityPermission) {
180        return PartyFactory.getInstance().getEntityFromPK(entityPermission, getPartyPK());
181    }
182    
183    public Party getParty() {
184        return getParty(EntityPermission.READ_ONLY);
185    }
186    
187    public Party getPartyForUpdate() {
188        return getParty(EntityPermission.READ_WRITE);
189    }
190    
191    public void setPartyPK(PartyPK partyPK)
192            throws PersistenceNotNullException, PersistenceReadOnlyException {
193        checkReadWrite();
194        _value.setPartyPK(partyPK);
195    }
196    
197    public void setParty(Party entity) {
198        setPartyPK(entity == null? null: entity.getPrimaryKey());
199    }
200    
201    public boolean getPartyPKHasBeenModified() {
202        return _value.getPartyPKHasBeenModified();
203    }
204    
205    public ContactListPK getContactListPK() {
206        return _value.getContactListPK();
207    }
208    
209    public ContactList getContactList(EntityPermission entityPermission) {
210        return ContactListFactory.getInstance().getEntityFromPK(entityPermission, getContactListPK());
211    }
212    
213    public ContactList getContactList() {
214        return getContactList(EntityPermission.READ_ONLY);
215    }
216    
217    public ContactList getContactListForUpdate() {
218        return getContactList(EntityPermission.READ_WRITE);
219    }
220    
221    public void setContactListPK(ContactListPK contactListPK)
222            throws PersistenceNotNullException, PersistenceReadOnlyException {
223        checkReadWrite();
224        _value.setContactListPK(contactListPK);
225    }
226    
227    public void setContactList(ContactList entity) {
228        setContactListPK(entity == null? null: entity.getPrimaryKey());
229    }
230    
231    public boolean getContactListPKHasBeenModified() {
232        return _value.getContactListPKHasBeenModified();
233    }
234    
235    public ContactListContactMechanismPurposePK getPreferredContactListContactMechanismPurposePK() {
236        return _value.getPreferredContactListContactMechanismPurposePK();
237    }
238    
239    public ContactListContactMechanismPurpose getPreferredContactListContactMechanismPurpose(EntityPermission entityPermission) {
240        ContactListContactMechanismPurposePK pk = getPreferredContactListContactMechanismPurposePK();
241        ContactListContactMechanismPurpose entity = pk == null? null: ContactListContactMechanismPurposeFactory.getInstance().getEntityFromPK(entityPermission, pk);
242        
243        return entity;
244    }
245    
246    public ContactListContactMechanismPurpose getPreferredContactListContactMechanismPurpose() {
247        return getPreferredContactListContactMechanismPurpose(EntityPermission.READ_ONLY);
248    }
249    
250    public ContactListContactMechanismPurpose getPreferredContactListContactMechanismPurposeForUpdate() {
251        return getPreferredContactListContactMechanismPurpose(EntityPermission.READ_WRITE);
252    }
253    
254    public void setPreferredContactListContactMechanismPurposePK(ContactListContactMechanismPurposePK preferredContactListContactMechanismPurposePK)
255            throws PersistenceNotNullException, PersistenceReadOnlyException {
256        checkReadWrite();
257        _value.setPreferredContactListContactMechanismPurposePK(preferredContactListContactMechanismPurposePK);
258    }
259    
260    public void setPreferredContactListContactMechanismPurpose(ContactListContactMechanismPurpose entity) {
261        setPreferredContactListContactMechanismPurposePK(entity == null? null: entity.getPrimaryKey());
262    }
263    
264    public boolean getPreferredContactListContactMechanismPurposePKHasBeenModified() {
265        return _value.getPreferredContactListContactMechanismPurposePKHasBeenModified();
266    }
267    
268    public Long getFromTime() {
269        return _value.getFromTime();
270    }
271    
272    public void setFromTime(Long fromTime)
273            throws PersistenceNotNullException, PersistenceReadOnlyException {
274        checkReadWrite();
275        _value.setFromTime(fromTime);
276    }
277    
278    public boolean getFromTimeHasBeenModified() {
279        return _value.getFromTimeHasBeenModified();
280    }
281    
282    public Long getThruTime() {
283        return _value.getThruTime();
284    }
285    
286    public void setThruTime(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}