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

/**
 * GeoCodeCountry.java
 */

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

import com.echothree.model.data.geo.common.pk.GeoCodeCountryPK;

import com.echothree.model.data.geo.common.pk.GeoCodePK;
import com.echothree.model.data.contact.common.pk.PostalAddressFormatPK;

import com.echothree.model.data.geo.server.entity.GeoCode;
import com.echothree.model.data.contact.server.entity.PostalAddressFormat;

import com.echothree.model.data.geo.server.factory.GeoCodeFactory;
import com.echothree.model.data.contact.server.factory.PostalAddressFormatFactory;

import com.echothree.model.data.geo.common.pk.GeoCodeCountryPK;

import com.echothree.model.data.geo.server.value.GeoCodeCountryValue;

import com.echothree.model.data.geo.server.factory.GeoCodeCountryFactory;

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 GeoCodeCountry
        extends BaseEntity
        implements Serializable {
    
    private GeoCodeCountryPK _pk;
    private GeoCodeCountryValue _value;
    
    /** Creates a new instance of GeoCodeCountry */
    public GeoCodeCountry()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of GeoCodeCountry */
    public GeoCodeCountry(GeoCodeCountryValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public GeoCodeCountryFactory getBaseFactoryInstance() {
        return GeoCodeCountryFactory.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 GeoCodeCountry that) {
            GeoCodeCountryValue thatValue = that.getGeoCodeCountryValue();
            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 GeoCodeCountryValue getGeoCodeCountryValue() {
        return _value;
    }
    
    public void setGeoCodeCountryValue(@Nonnull GeoCodeCountryValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public GeoCodeCountryPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public GeoCodePK getGeoCodePK() {
        return _value.getGeoCodePK();
    }
    
    @Nonnull
    public GeoCode getGeoCode(EntityPermission entityPermission) {
        return GeoCodeFactory.getInstance().getEntityFromPK(entityPermission, getGeoCodePK());
    }
    
    @Nonnull
    public GeoCode getGeoCode() {
        return getGeoCode(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public GeoCode getGeoCodeForUpdate() {
        return getGeoCode(EntityPermission.READ_WRITE);
    }
    
    public void setGeoCodePK(@Nonnull GeoCodePK geoCodePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setGeoCodePK(geoCodePK);
    }
    
    public void setGeoCode(@Nonnull GeoCode entity) {
        setGeoCodePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getGeoCodePKHasBeenModified() {
        return _value.getGeoCodePKHasBeenModified();
    }
    
    @Nullable
    public String getTelephoneCode() {
        return _value.getTelephoneCode();
    }
    
    public void setTelephoneCode(@Nullable String telephoneCode)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setTelephoneCode(telephoneCode);
    }
    
    public boolean getTelephoneCodeHasBeenModified() {
        return _value.getTelephoneCodeHasBeenModified();
    }
    
    @Nullable
    public String getAreaCodePattern() {
        return _value.getAreaCodePattern();
    }
    
    public void setAreaCodePattern(@Nullable String areaCodePattern)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAreaCodePattern(areaCodePattern);
    }
    
    public boolean getAreaCodePatternHasBeenModified() {
        return _value.getAreaCodePatternHasBeenModified();
    }
    
    @Nonnull
    public Boolean getAreaCodeRequired() {
        return _value.getAreaCodeRequired();
    }
    
    public void setAreaCodeRequired(@Nonnull Boolean areaCodeRequired)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAreaCodeRequired(areaCodeRequired);
    }
    
    public boolean getAreaCodeRequiredHasBeenModified() {
        return _value.getAreaCodeRequiredHasBeenModified();
    }
    
    @Nullable
    public String getAreaCodeExample() {
        return _value.getAreaCodeExample();
    }
    
    public void setAreaCodeExample(@Nullable String areaCodeExample)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAreaCodeExample(areaCodeExample);
    }
    
    public boolean getAreaCodeExampleHasBeenModified() {
        return _value.getAreaCodeExampleHasBeenModified();
    }
    
    @Nullable
    public String getTelephoneNumberPattern() {
        return _value.getTelephoneNumberPattern();
    }
    
    public void setTelephoneNumberPattern(@Nullable String telephoneNumberPattern)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setTelephoneNumberPattern(telephoneNumberPattern);
    }
    
    public boolean getTelephoneNumberPatternHasBeenModified() {
        return _value.getTelephoneNumberPatternHasBeenModified();
    }
    
    @Nullable
    public String getTelephoneNumberExample() {
        return _value.getTelephoneNumberExample();
    }
    
    public void setTelephoneNumberExample(@Nullable String telephoneNumberExample)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setTelephoneNumberExample(telephoneNumberExample);
    }
    
    public boolean getTelephoneNumberExampleHasBeenModified() {
        return _value.getTelephoneNumberExampleHasBeenModified();
    }
    
    @Nonnull
    public PostalAddressFormatPK getPostalAddressFormatPK() {
        return _value.getPostalAddressFormatPK();
    }
    
    @Nonnull
    public PostalAddressFormat getPostalAddressFormat(EntityPermission entityPermission) {
        return PostalAddressFormatFactory.getInstance().getEntityFromPK(entityPermission, getPostalAddressFormatPK());
    }
    
    @Nonnull
    public PostalAddressFormat getPostalAddressFormat() {
        return getPostalAddressFormat(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public PostalAddressFormat getPostalAddressFormatForUpdate() {
        return getPostalAddressFormat(EntityPermission.READ_WRITE);
    }
    
    public void setPostalAddressFormatPK(@Nonnull PostalAddressFormatPK postalAddressFormatPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPostalAddressFormatPK(postalAddressFormatPK);
    }
    
    public void setPostalAddressFormat(@Nonnull PostalAddressFormat entity) {
        setPostalAddressFormatPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPostalAddressFormatPKHasBeenModified() {
        return _value.getPostalAddressFormatPKHasBeenModified();
    }
    
    @Nonnull
    public Boolean getCityRequired() {
        return _value.getCityRequired();
    }
    
    public void setCityRequired(@Nonnull Boolean cityRequired)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCityRequired(cityRequired);
    }
    
    public boolean getCityRequiredHasBeenModified() {
        return _value.getCityRequiredHasBeenModified();
    }
    
    @Nonnull
    public Boolean getCityGeoCodeRequired() {
        return _value.getCityGeoCodeRequired();
    }
    
    public void setCityGeoCodeRequired(@Nonnull Boolean cityGeoCodeRequired)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCityGeoCodeRequired(cityGeoCodeRequired);
    }
    
    public boolean getCityGeoCodeRequiredHasBeenModified() {
        return _value.getCityGeoCodeRequiredHasBeenModified();
    }
    
    @Nonnull
    public Boolean getStateRequired() {
        return _value.getStateRequired();
    }
    
    public void setStateRequired(@Nonnull Boolean stateRequired)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setStateRequired(stateRequired);
    }
    
    public boolean getStateRequiredHasBeenModified() {
        return _value.getStateRequiredHasBeenModified();
    }
    
    @Nonnull
    public Boolean getStateGeoCodeRequired() {
        return _value.getStateGeoCodeRequired();
    }
    
    public void setStateGeoCodeRequired(@Nonnull Boolean stateGeoCodeRequired)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setStateGeoCodeRequired(stateGeoCodeRequired);
    }
    
    public boolean getStateGeoCodeRequiredHasBeenModified() {
        return _value.getStateGeoCodeRequiredHasBeenModified();
    }
    
    @Nullable
    public String getPostalCodePattern() {
        return _value.getPostalCodePattern();
    }
    
    public void setPostalCodePattern(@Nullable String postalCodePattern)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPostalCodePattern(postalCodePattern);
    }
    
    public boolean getPostalCodePatternHasBeenModified() {
        return _value.getPostalCodePatternHasBeenModified();
    }
    
    @Nonnull
    public Boolean getPostalCodeRequired() {
        return _value.getPostalCodeRequired();
    }
    
    public void setPostalCodeRequired(@Nonnull Boolean postalCodeRequired)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPostalCodeRequired(postalCodeRequired);
    }
    
    public boolean getPostalCodeRequiredHasBeenModified() {
        return _value.getPostalCodeRequiredHasBeenModified();
    }
    
    @Nonnull
    public Boolean getPostalCodeGeoCodeRequired() {
        return _value.getPostalCodeGeoCodeRequired();
    }
    
    public void setPostalCodeGeoCodeRequired(@Nonnull Boolean postalCodeGeoCodeRequired)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPostalCodeGeoCodeRequired(postalCodeGeoCodeRequired);
    }
    
    public boolean getPostalCodeGeoCodeRequiredHasBeenModified() {
        return _value.getPostalCodeGeoCodeRequiredHasBeenModified();
    }
    
    @Nullable
    public Integer getPostalCodeLength() {
        return _value.getPostalCodeLength();
    }
    
    public void setPostalCodeLength(@Nullable Integer postalCodeLength)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPostalCodeLength(postalCodeLength);
    }
    
    public boolean getPostalCodeLengthHasBeenModified() {
        return _value.getPostalCodeLengthHasBeenModified();
    }
    
    @Nullable
    public Integer getPostalCodeGeoCodeLength() {
        return _value.getPostalCodeGeoCodeLength();
    }
    
    public void setPostalCodeGeoCodeLength(@Nullable Integer postalCodeGeoCodeLength)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPostalCodeGeoCodeLength(postalCodeGeoCodeLength);
    }
    
    public boolean getPostalCodeGeoCodeLengthHasBeenModified() {
        return _value.getPostalCodeGeoCodeLengthHasBeenModified();
    }
    
    @Nullable
    public String getPostalCodeExample() {
        return _value.getPostalCodeExample();
    }
    
    public void setPostalCodeExample(@Nullable String postalCodeExample)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPostalCodeExample(postalCodeExample);
    }
    
    public boolean getPostalCodeExampleHasBeenModified() {
        return _value.getPostalCodeExampleHasBeenModified();
    }
    
    @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();
    }
    
}