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 * Person.java
021 */
022
023package com.echothree.model.data.party.server.entity;
024
025import com.echothree.model.data.party.common.pk.PersonPK;
026
027import com.echothree.model.data.party.common.pk.PartyPK;
028import com.echothree.model.data.party.common.pk.PersonalTitlePK;
029import com.echothree.model.data.party.common.pk.NameSuffixPK;
030
031import com.echothree.model.data.party.server.entity.Party;
032import com.echothree.model.data.party.server.entity.PersonalTitle;
033import com.echothree.model.data.party.server.entity.NameSuffix;
034
035import com.echothree.model.data.party.server.factory.PartyFactory;
036import com.echothree.model.data.party.server.factory.PersonalTitleFactory;
037import com.echothree.model.data.party.server.factory.NameSuffixFactory;
038
039import com.echothree.model.data.party.common.pk.PersonPK;
040
041import com.echothree.model.data.party.server.value.PersonValue;
042
043import com.echothree.model.data.party.server.factory.PersonFactory;
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 Person
062        extends BaseEntity
063        implements Serializable {
064    
065    private PersonPK _pk;
066    private PersonValue _value;
067    
068    /** Creates a new instance of Person */
069    public Person()
070            throws PersistenceException {
071        super();
072    }
073    
074    /** Creates a new instance of Person */
075    public Person(PersonValue value, EntityPermission entityPermission) {
076        super(entityPermission);
077        
078        _value = value;
079        _pk = value.getPrimaryKey();
080    }
081    
082    @Override
083    public PersonFactory getBaseFactoryInstance() {
084        return PersonFactory.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 Person that) {
108            PersonValue thatValue = that.getPersonValue();
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 PersonValue getPersonValue() {
134        return _value;
135    }
136    
137    public void setPersonValue(PersonValue value)
138            throws PersistenceReadOnlyException {
139        checkReadWrite();
140        _value = value;
141    }
142    
143    @Override
144    public PersonPK getPrimaryKey() {
145        return _pk;
146    }
147    
148    public PartyPK getPartyPK() {
149        return _value.getPartyPK();
150    }
151    
152    public Party getParty(Session session, EntityPermission entityPermission) {
153        return PartyFactory.getInstance().getEntityFromPK(session, entityPermission, getPartyPK());
154    }
155    
156    public Party getParty(EntityPermission entityPermission) {
157        return getParty(ThreadSession.currentSession(), entityPermission);
158    }
159    
160    public Party getParty(Session session) {
161        return getParty(session, EntityPermission.READ_ONLY);
162    }
163    
164    public Party getParty() {
165        return getParty(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
166    }
167    
168    public Party getPartyForUpdate(Session session) {
169        return getParty(session, EntityPermission.READ_WRITE);
170    }
171    
172    public Party getPartyForUpdate() {
173        return getParty(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
174    }
175    
176    public void setPartyPK(PartyPK partyPK)
177            throws PersistenceNotNullException, PersistenceReadOnlyException {
178        checkReadWrite();
179        _value.setPartyPK(partyPK);
180    }
181    
182    public void setParty(Party entity) {
183        setPartyPK(entity == null? null: entity.getPrimaryKey());
184    }
185    
186    public boolean getPartyPKHasBeenModified() {
187        return _value.getPartyPKHasBeenModified();
188    }
189    
190    public PersonalTitlePK getPersonalTitlePK() {
191        return _value.getPersonalTitlePK();
192    }
193    
194    public PersonalTitle getPersonalTitle(Session session, EntityPermission entityPermission) {
195        PersonalTitlePK pk = getPersonalTitlePK();
196        PersonalTitle entity = pk == null? null: PersonalTitleFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
197        
198        return entity;
199    }
200    
201    public PersonalTitle getPersonalTitle(EntityPermission entityPermission) {
202        return getPersonalTitle(ThreadSession.currentSession(), entityPermission);
203    }
204    
205    public PersonalTitle getPersonalTitle(Session session) {
206        return getPersonalTitle(session, EntityPermission.READ_ONLY);
207    }
208    
209    public PersonalTitle getPersonalTitle() {
210        return getPersonalTitle(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
211    }
212    
213    public PersonalTitle getPersonalTitleForUpdate(Session session) {
214        return getPersonalTitle(session, EntityPermission.READ_WRITE);
215    }
216    
217    public PersonalTitle getPersonalTitleForUpdate() {
218        return getPersonalTitle(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
219    }
220    
221    public void setPersonalTitlePK(PersonalTitlePK personalTitlePK)
222            throws PersistenceNotNullException, PersistenceReadOnlyException {
223        checkReadWrite();
224        _value.setPersonalTitlePK(personalTitlePK);
225    }
226    
227    public void setPersonalTitle(PersonalTitle entity) {
228        setPersonalTitlePK(entity == null? null: entity.getPrimaryKey());
229    }
230    
231    public boolean getPersonalTitlePKHasBeenModified() {
232        return _value.getPersonalTitlePKHasBeenModified();
233    }
234    
235    public String getFirstName() {
236        return _value.getFirstName();
237    }
238    
239    public void setFirstName(String firstName)
240            throws PersistenceNotNullException, PersistenceReadOnlyException {
241        checkReadWrite();
242        _value.setFirstName(firstName);
243    }
244    
245    public boolean getFirstNameHasBeenModified() {
246        return _value.getFirstNameHasBeenModified();
247    }
248    
249    public String getFirstNameSdx() {
250        return _value.getFirstNameSdx();
251    }
252    
253    public void setFirstNameSdx(String firstNameSdx)
254            throws PersistenceNotNullException, PersistenceReadOnlyException {
255        checkReadWrite();
256        _value.setFirstNameSdx(firstNameSdx);
257    }
258    
259    public boolean getFirstNameSdxHasBeenModified() {
260        return _value.getFirstNameSdxHasBeenModified();
261    }
262    
263    public String getMiddleName() {
264        return _value.getMiddleName();
265    }
266    
267    public void setMiddleName(String middleName)
268            throws PersistenceNotNullException, PersistenceReadOnlyException {
269        checkReadWrite();
270        _value.setMiddleName(middleName);
271    }
272    
273    public boolean getMiddleNameHasBeenModified() {
274        return _value.getMiddleNameHasBeenModified();
275    }
276    
277    public String getMiddleNameSdx() {
278        return _value.getMiddleNameSdx();
279    }
280    
281    public void setMiddleNameSdx(String middleNameSdx)
282            throws PersistenceNotNullException, PersistenceReadOnlyException {
283        checkReadWrite();
284        _value.setMiddleNameSdx(middleNameSdx);
285    }
286    
287    public boolean getMiddleNameSdxHasBeenModified() {
288        return _value.getMiddleNameSdxHasBeenModified();
289    }
290    
291    public String getLastName() {
292        return _value.getLastName();
293    }
294    
295    public void setLastName(String lastName)
296            throws PersistenceNotNullException, PersistenceReadOnlyException {
297        checkReadWrite();
298        _value.setLastName(lastName);
299    }
300    
301    public boolean getLastNameHasBeenModified() {
302        return _value.getLastNameHasBeenModified();
303    }
304    
305    public String getLastNameSdx() {
306        return _value.getLastNameSdx();
307    }
308    
309    public void setLastNameSdx(String lastNameSdx)
310            throws PersistenceNotNullException, PersistenceReadOnlyException {
311        checkReadWrite();
312        _value.setLastNameSdx(lastNameSdx);
313    }
314    
315    public boolean getLastNameSdxHasBeenModified() {
316        return _value.getLastNameSdxHasBeenModified();
317    }
318    
319    public NameSuffixPK getNameSuffixPK() {
320        return _value.getNameSuffixPK();
321    }
322    
323    public NameSuffix getNameSuffix(Session session, EntityPermission entityPermission) {
324        NameSuffixPK pk = getNameSuffixPK();
325        NameSuffix entity = pk == null? null: NameSuffixFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
326        
327        return entity;
328    }
329    
330    public NameSuffix getNameSuffix(EntityPermission entityPermission) {
331        return getNameSuffix(ThreadSession.currentSession(), entityPermission);
332    }
333    
334    public NameSuffix getNameSuffix(Session session) {
335        return getNameSuffix(session, EntityPermission.READ_ONLY);
336    }
337    
338    public NameSuffix getNameSuffix() {
339        return getNameSuffix(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
340    }
341    
342    public NameSuffix getNameSuffixForUpdate(Session session) {
343        return getNameSuffix(session, EntityPermission.READ_WRITE);
344    }
345    
346    public NameSuffix getNameSuffixForUpdate() {
347        return getNameSuffix(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
348    }
349    
350    public void setNameSuffixPK(NameSuffixPK nameSuffixPK)
351            throws PersistenceNotNullException, PersistenceReadOnlyException {
352        checkReadWrite();
353        _value.setNameSuffixPK(nameSuffixPK);
354    }
355    
356    public void setNameSuffix(NameSuffix entity) {
357        setNameSuffixPK(entity == null? null: entity.getPrimaryKey());
358    }
359    
360    public boolean getNameSuffixPKHasBeenModified() {
361        return _value.getNameSuffixPKHasBeenModified();
362    }
363    
364    public Long getFromTime() {
365        return _value.getFromTime();
366    }
367    
368    public void setFromTime(Long fromTime)
369            throws PersistenceNotNullException, PersistenceReadOnlyException {
370        checkReadWrite();
371        _value.setFromTime(fromTime);
372    }
373    
374    public boolean getFromTimeHasBeenModified() {
375        return _value.getFromTimeHasBeenModified();
376    }
377    
378    public Long getThruTime() {
379        return _value.getThruTime();
380    }
381    
382    public void setThruTime(Long thruTime)
383            throws PersistenceNotNullException, PersistenceReadOnlyException {
384        checkReadWrite();
385        _value.setThruTime(thruTime);
386    }
387    
388    public boolean getThruTimeHasBeenModified() {
389        return _value.getThruTimeHasBeenModified();
390    }
391    
392}