// --------------------------------------------------------------------------------
// 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
// --------------------------------------------------------------------------------

/**
 * ContactPostalAddress.java
 */

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

import com.echothree.model.data.contact.common.pk.ContactPostalAddressPK;

import com.echothree.model.data.contact.common.pk.ContactMechanismPK;
import com.echothree.model.data.party.common.pk.PersonalTitlePK;
import com.echothree.model.data.party.common.pk.NameSuffixPK;
import com.echothree.model.data.geo.common.pk.GeoCodePK;

import com.echothree.model.data.contact.server.entity.ContactMechanism;
import com.echothree.model.data.party.server.entity.PersonalTitle;
import com.echothree.model.data.party.server.entity.NameSuffix;
import com.echothree.model.data.geo.server.entity.GeoCode;

import com.echothree.model.data.contact.server.factory.ContactMechanismFactory;
import com.echothree.model.data.party.server.factory.PersonalTitleFactory;
import com.echothree.model.data.party.server.factory.NameSuffixFactory;
import com.echothree.model.data.geo.server.factory.GeoCodeFactory;

import com.echothree.model.data.contact.common.pk.ContactPostalAddressPK;

import com.echothree.model.data.contact.server.value.ContactPostalAddressValue;

import com.echothree.model.data.contact.server.factory.ContactPostalAddressFactory;

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 ContactPostalAddress
        extends BaseEntity
        implements Serializable {
    
    private ContactPostalAddressPK _pk;
    private ContactPostalAddressValue _value;
    
    /** Creates a new instance of ContactPostalAddress */
    public ContactPostalAddress()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of ContactPostalAddress */
    public ContactPostalAddress(ContactPostalAddressValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public ContactPostalAddressFactory getBaseFactoryInstance() {
        return ContactPostalAddressFactory.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 ContactPostalAddress that) {
            ContactPostalAddressValue thatValue = that.getContactPostalAddressValue();
            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 ContactPostalAddressValue getContactPostalAddressValue() {
        return _value;
    }
    
    public void setContactPostalAddressValue(@Nonnull ContactPostalAddressValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public ContactPostalAddressPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public ContactMechanismPK getContactMechanismPK() {
        return _value.getContactMechanismPK();
    }
    
    @Nonnull
    public ContactMechanism getContactMechanism(EntityPermission entityPermission) {
        return ContactMechanismFactory.getInstance().getEntityFromPK(entityPermission, getContactMechanismPK());
    }
    
    @Nonnull
    public ContactMechanism getContactMechanism() {
        return getContactMechanism(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public ContactMechanism getContactMechanismForUpdate() {
        return getContactMechanism(EntityPermission.READ_WRITE);
    }
    
    public void setContactMechanismPK(@Nonnull ContactMechanismPK contactMechanismPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setContactMechanismPK(contactMechanismPK);
    }
    
    public void setContactMechanism(@Nonnull ContactMechanism entity) {
        setContactMechanismPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getContactMechanismPKHasBeenModified() {
        return _value.getContactMechanismPKHasBeenModified();
    }
    
    @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();
    }
    
    @Nullable
    public String getCompanyName() {
        return _value.getCompanyName();
    }
    
    public void setCompanyName(@Nullable String companyName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCompanyName(companyName);
    }
    
    public boolean getCompanyNameHasBeenModified() {
        return _value.getCompanyNameHasBeenModified();
    }
    
    @Nullable
    public String getAttention() {
        return _value.getAttention();
    }
    
    public void setAttention(@Nullable String attention)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAttention(attention);
    }
    
    public boolean getAttentionHasBeenModified() {
        return _value.getAttentionHasBeenModified();
    }
    
    @Nonnull
    public String getAddress1() {
        return _value.getAddress1();
    }
    
    public void setAddress1(@Nonnull String address1)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAddress1(address1);
    }
    
    public boolean getAddress1HasBeenModified() {
        return _value.getAddress1HasBeenModified();
    }
    
    @Nullable
    public String getAddress2() {
        return _value.getAddress2();
    }
    
    public void setAddress2(@Nullable String address2)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAddress2(address2);
    }
    
    public boolean getAddress2HasBeenModified() {
        return _value.getAddress2HasBeenModified();
    }
    
    @Nullable
    public String getAddress3() {
        return _value.getAddress3();
    }
    
    public void setAddress3(@Nullable String address3)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAddress3(address3);
    }
    
    public boolean getAddress3HasBeenModified() {
        return _value.getAddress3HasBeenModified();
    }
    
    @Nullable
    public String getCity() {
        return _value.getCity();
    }
    
    public void setCity(@Nullable String city)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCity(city);
    }
    
    public boolean getCityHasBeenModified() {
        return _value.getCityHasBeenModified();
    }
    
    @Nullable
    public GeoCodePK getCityGeoCodePK() {
        return _value.getCityGeoCodePK();
    }
    
    @Nullable
    public GeoCode getCityGeoCode(EntityPermission entityPermission) {
        GeoCodePK pk = getCityGeoCodePK();
        GeoCode entity = pk == null? null: GeoCodeFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public GeoCode getCityGeoCode() {
        return getCityGeoCode(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public GeoCode getCityGeoCodeForUpdate() {
        return getCityGeoCode(EntityPermission.READ_WRITE);
    }
    
    public void setCityGeoCodePK(@Nullable GeoCodePK cityGeoCodePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCityGeoCodePK(cityGeoCodePK);
    }
    
    public void setCityGeoCode(@Nullable GeoCode entity) {
        setCityGeoCodePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCityGeoCodePKHasBeenModified() {
        return _value.getCityGeoCodePKHasBeenModified();
    }
    
    @Nullable
    public GeoCodePK getCountyGeoCodePK() {
        return _value.getCountyGeoCodePK();
    }
    
    @Nullable
    public GeoCode getCountyGeoCode(EntityPermission entityPermission) {
        GeoCodePK pk = getCountyGeoCodePK();
        GeoCode entity = pk == null? null: GeoCodeFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public GeoCode getCountyGeoCode() {
        return getCountyGeoCode(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public GeoCode getCountyGeoCodeForUpdate() {
        return getCountyGeoCode(EntityPermission.READ_WRITE);
    }
    
    public void setCountyGeoCodePK(@Nullable GeoCodePK countyGeoCodePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCountyGeoCodePK(countyGeoCodePK);
    }
    
    public void setCountyGeoCode(@Nullable GeoCode entity) {
        setCountyGeoCodePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCountyGeoCodePKHasBeenModified() {
        return _value.getCountyGeoCodePKHasBeenModified();
    }
    
    @Nullable
    public String getState() {
        return _value.getState();
    }
    
    public void setState(@Nullable String state)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setState(state);
    }
    
    public boolean getStateHasBeenModified() {
        return _value.getStateHasBeenModified();
    }
    
    @Nullable
    public GeoCodePK getStateGeoCodePK() {
        return _value.getStateGeoCodePK();
    }
    
    @Nullable
    public GeoCode getStateGeoCode(EntityPermission entityPermission) {
        GeoCodePK pk = getStateGeoCodePK();
        GeoCode entity = pk == null? null: GeoCodeFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public GeoCode getStateGeoCode() {
        return getStateGeoCode(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public GeoCode getStateGeoCodeForUpdate() {
        return getStateGeoCode(EntityPermission.READ_WRITE);
    }
    
    public void setStateGeoCodePK(@Nullable GeoCodePK stateGeoCodePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setStateGeoCodePK(stateGeoCodePK);
    }
    
    public void setStateGeoCode(@Nullable GeoCode entity) {
        setStateGeoCodePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getStateGeoCodePKHasBeenModified() {
        return _value.getStateGeoCodePKHasBeenModified();
    }
    
    @Nullable
    public String getPostalCode() {
        return _value.getPostalCode();
    }
    
    public void setPostalCode(@Nullable String postalCode)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPostalCode(postalCode);
    }
    
    public boolean getPostalCodeHasBeenModified() {
        return _value.getPostalCodeHasBeenModified();
    }
    
    @Nullable
    public GeoCodePK getPostalCodeGeoCodePK() {
        return _value.getPostalCodeGeoCodePK();
    }
    
    @Nullable
    public GeoCode getPostalCodeGeoCode(EntityPermission entityPermission) {
        GeoCodePK pk = getPostalCodeGeoCodePK();
        GeoCode entity = pk == null? null: GeoCodeFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public GeoCode getPostalCodeGeoCode() {
        return getPostalCodeGeoCode(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public GeoCode getPostalCodeGeoCodeForUpdate() {
        return getPostalCodeGeoCode(EntityPermission.READ_WRITE);
    }
    
    public void setPostalCodeGeoCodePK(@Nullable GeoCodePK postalCodeGeoCodePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPostalCodeGeoCodePK(postalCodeGeoCodePK);
    }
    
    public void setPostalCodeGeoCode(@Nullable GeoCode entity) {
        setPostalCodeGeoCodePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPostalCodeGeoCodePKHasBeenModified() {
        return _value.getPostalCodeGeoCodePKHasBeenModified();
    }
    
    @Nonnull
    public GeoCodePK getCountryGeoCodePK() {
        return _value.getCountryGeoCodePK();
    }
    
    @Nonnull
    public GeoCode getCountryGeoCode(EntityPermission entityPermission) {
        return GeoCodeFactory.getInstance().getEntityFromPK(entityPermission, getCountryGeoCodePK());
    }
    
    @Nonnull
    public GeoCode getCountryGeoCode() {
        return getCountryGeoCode(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public GeoCode getCountryGeoCodeForUpdate() {
        return getCountryGeoCode(EntityPermission.READ_WRITE);
    }
    
    public void setCountryGeoCodePK(@Nonnull GeoCodePK countryGeoCodePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCountryGeoCodePK(countryGeoCodePK);
    }
    
    public void setCountryGeoCode(@Nonnull GeoCode entity) {
        setCountryGeoCodePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCountryGeoCodePKHasBeenModified() {
        return _value.getCountryGeoCodePKHasBeenModified();
    }
    
    @Nonnull
    public Boolean getIsCommercial() {
        return _value.getIsCommercial();
    }
    
    public void setIsCommercial(@Nonnull Boolean isCommercial)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setIsCommercial(isCommercial);
    }
    
    public boolean getIsCommercialHasBeenModified() {
        return _value.getIsCommercialHasBeenModified();
    }
    
    @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();
    }
    
}