// --------------------------------------------------------------------------------
// Copyright 2002-2026 Echo Three, LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// --------------------------------------------------------------------------------
// Generated File -- DO NOT EDIT BY HAND
// --------------------------------------------------------------------------------

/**
 * Person.java
 */

package com.echothree.model.data.party.server.entity;

import com.echothree.model.data.party.common.pk.PersonPK;

import com.echothree.model.data.party.common.pk.PartyPK;
import com.echothree.model.data.party.common.pk.PersonalTitlePK;
import com.echothree.model.data.party.common.pk.NameSuffixPK;

import com.echothree.model.data.party.server.entity.Party;
import com.echothree.model.data.party.server.entity.PersonalTitle;
import com.echothree.model.data.party.server.entity.NameSuffix;

import com.echothree.model.data.party.server.factory.PartyFactory;
import com.echothree.model.data.party.server.factory.PersonalTitleFactory;
import com.echothree.model.data.party.server.factory.NameSuffixFactory;

import com.echothree.model.data.party.common.pk.PersonPK;

import com.echothree.model.data.party.server.value.PersonValue;

import com.echothree.model.data.party.server.factory.PersonFactory;

import com.echothree.util.common.exception.PersistenceException;
import com.echothree.util.common.exception.PersistenceDatabaseException;
import com.echothree.util.common.exception.PersistenceNotNullException;
import com.echothree.util.common.exception.PersistenceReadOnlyException;

import com.echothree.util.common.persistence.BasePK;

import com.echothree.util.common.persistence.type.ByteArray;

import com.echothree.util.server.persistence.BaseEntity;
import com.echothree.util.server.persistence.EntityPermission;
import com.echothree.util.server.persistence.Session;
import com.echothree.util.server.persistence.ThreadSession;

import java.io.Serializable;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

public class Person
        extends BaseEntity
        implements Serializable {
    
    private PersonPK _pk;
    private PersonValue _value;
    
    /** Creates a new instance of Person */
    public Person()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of Person */
    public Person(PersonValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public PersonFactory getBaseFactoryInstance() {
        return PersonFactory.getInstance();
    }
    
    @Override
    public boolean hasBeenModified() {
        return _value.hasBeenModified();
    }
    
    @Override
    public int hashCode() {
        return _pk.hashCode();
    }
    
    @Override
    @Nonnull
    public String toString() {
        return _pk.toString();
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(other instanceof Person that) {
            PersonValue thatValue = that.getPersonValue();
            return _value.equals(thatValue);
        } else {
            return false;
        }
    }
    
    @Override
    public void store()
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().store(this);
    }
    
    @Override
    public void remove()
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().remove(this);
    }
    
    @Nonnull
    public PersonValue getPersonValue() {
        return _value;
    }
    
    public void setPersonValue(@Nonnull PersonValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public PersonPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public PartyPK getPartyPK() {
        return _value.getPartyPK();
    }
    
    @Nonnull
    public Party getParty(EntityPermission entityPermission) {
        return PartyFactory.getInstance().getEntityFromPK(entityPermission, getPartyPK());
    }
    
    @Nonnull
    public Party getParty() {
        return getParty(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Party getPartyForUpdate() {
        return getParty(EntityPermission.READ_WRITE);
    }
    
    public void setPartyPK(@Nonnull PartyPK partyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPartyPK(partyPK);
    }
    
    public void setParty(@Nonnull Party entity) {
        setPartyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPartyPKHasBeenModified() {
        return _value.getPartyPKHasBeenModified();
    }
    
    @Nullable
    public PersonalTitlePK getPersonalTitlePK() {
        return _value.getPersonalTitlePK();
    }
    
    @Nullable
    public PersonalTitle getPersonalTitle(EntityPermission entityPermission) {
        PersonalTitlePK pk = getPersonalTitlePK();
        PersonalTitle entity = pk == null? null: PersonalTitleFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public PersonalTitle getPersonalTitle() {
        return getPersonalTitle(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public PersonalTitle getPersonalTitleForUpdate() {
        return getPersonalTitle(EntityPermission.READ_WRITE);
    }
    
    public void setPersonalTitlePK(@Nullable PersonalTitlePK personalTitlePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPersonalTitlePK(personalTitlePK);
    }
    
    public void setPersonalTitle(@Nullable PersonalTitle entity) {
        setPersonalTitlePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPersonalTitlePKHasBeenModified() {
        return _value.getPersonalTitlePKHasBeenModified();
    }
    
    @Nullable
    public String getFirstName() {
        return _value.getFirstName();
    }
    
    public void setFirstName(@Nullable String firstName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setFirstName(firstName);
    }
    
    public boolean getFirstNameHasBeenModified() {
        return _value.getFirstNameHasBeenModified();
    }
    
    @Nullable
    public String getFirstNameSdx() {
        return _value.getFirstNameSdx();
    }
    
    public void setFirstNameSdx(@Nullable String firstNameSdx)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setFirstNameSdx(firstNameSdx);
    }
    
    public boolean getFirstNameSdxHasBeenModified() {
        return _value.getFirstNameSdxHasBeenModified();
    }
    
    @Nullable
    public String getMiddleName() {
        return _value.getMiddleName();
    }
    
    public void setMiddleName(@Nullable String middleName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setMiddleName(middleName);
    }
    
    public boolean getMiddleNameHasBeenModified() {
        return _value.getMiddleNameHasBeenModified();
    }
    
    @Nullable
    public String getMiddleNameSdx() {
        return _value.getMiddleNameSdx();
    }
    
    public void setMiddleNameSdx(@Nullable String middleNameSdx)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setMiddleNameSdx(middleNameSdx);
    }
    
    public boolean getMiddleNameSdxHasBeenModified() {
        return _value.getMiddleNameSdxHasBeenModified();
    }
    
    @Nullable
    public String getLastName() {
        return _value.getLastName();
    }
    
    public void setLastName(@Nullable String lastName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setLastName(lastName);
    }
    
    public boolean getLastNameHasBeenModified() {
        return _value.getLastNameHasBeenModified();
    }
    
    @Nullable
    public String getLastNameSdx() {
        return _value.getLastNameSdx();
    }
    
    public void setLastNameSdx(@Nullable String lastNameSdx)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setLastNameSdx(lastNameSdx);
    }
    
    public boolean getLastNameSdxHasBeenModified() {
        return _value.getLastNameSdxHasBeenModified();
    }
    
    @Nullable
    public NameSuffixPK getNameSuffixPK() {
        return _value.getNameSuffixPK();
    }
    
    @Nullable
    public NameSuffix getNameSuffix(EntityPermission entityPermission) {
        NameSuffixPK pk = getNameSuffixPK();
        NameSuffix entity = pk == null? null: NameSuffixFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public NameSuffix getNameSuffix() {
        return getNameSuffix(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public NameSuffix getNameSuffixForUpdate() {
        return getNameSuffix(EntityPermission.READ_WRITE);
    }
    
    public void setNameSuffixPK(@Nullable NameSuffixPK nameSuffixPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setNameSuffixPK(nameSuffixPK);
    }
    
    public void setNameSuffix(@Nullable NameSuffix entity) {
        setNameSuffixPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getNameSuffixPKHasBeenModified() {
        return _value.getNameSuffixPKHasBeenModified();
    }
    
    @Nonnull
    public Long getFromTime() {
        return _value.getFromTime();
    }
    
    public void setFromTime(@Nonnull Long fromTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setFromTime(fromTime);
    }
    
    public boolean getFromTimeHasBeenModified() {
        return _value.getFromTimeHasBeenModified();
    }
    
    @Nonnull
    public Long getThruTime() {
        return _value.getThruTime();
    }
    
    public void setThruTime(@Nonnull Long thruTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setThruTime(thruTime);
    }
    
    public boolean getThruTimeHasBeenModified() {
        return _value.getThruTimeHasBeenModified();
    }
    
}