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
017package com.echothree.model.control.geo.server.logic;
018
019import com.echothree.control.user.geo.common.spec.GeoCodeUniversalSpec;
020import com.echothree.model.control.contact.server.control.ContactControl;
021import com.echothree.model.control.core.common.ComponentVendors;
022import com.echothree.model.control.core.common.EntityTypes;
023import com.echothree.model.control.core.common.exception.InvalidParameterCountException;
024import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
025import com.echothree.model.control.geo.common.exception.UnknownGeoCodeAliasTypeNameException;
026import com.echothree.model.control.geo.common.exception.UnknownGeoCodeNameException;
027import com.echothree.model.control.geo.server.control.GeoControl;
028import com.echothree.model.control.item.server.control.ItemControl;
029import com.echothree.model.control.selector.server.control.SelectorControl;
030import com.echothree.model.control.tax.server.control.TaxControl;
031import com.echothree.model.data.geo.server.entity.GeoCode;
032import com.echothree.model.data.geo.server.entity.GeoCodeAlias;
033import com.echothree.model.data.geo.server.entity.GeoCodeScope;
034import com.echothree.model.data.geo.server.entity.GeoCodeType;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.persistence.BasePK;
037import com.echothree.util.server.control.BaseLogic;
038import com.echothree.util.server.message.ExecutionErrorAccumulator;
039import com.echothree.util.server.persistence.EntityPermission;
040import com.echothree.util.server.persistence.Session;
041import javax.enterprise.context.ApplicationScoped;
042import javax.enterprise.inject.spi.CDI;
043
044@ApplicationScoped
045public class GeoCodeLogic
046        extends BaseLogic {
047
048    protected GeoCodeLogic() {
049        super();
050    }
051
052    public static GeoCodeLogic getInstance() {
053        return CDI.current().select(GeoCodeLogic.class).get();
054    }
055
056    public GeoCode getGeoCodeByName(final ExecutionErrorAccumulator eea, final String geoCodeName,
057            final EntityPermission entityPermission) {
058        var geoControl = Session.getModelController(GeoControl.class);
059        var geoCode = geoControl.getGeoCodeByName(geoCodeName, entityPermission);
060
061        if(geoCode == null) {
062            handleExecutionError(UnknownGeoCodeNameException.class, eea, ExecutionErrors.UnknownGeoCodeName.name(), geoCodeName);
063        }
064
065        return geoCode;
066    }
067
068    public GeoCode getGeoCodeByName(final ExecutionErrorAccumulator eea, final String geoCodeName) {
069        return getGeoCodeByName(eea, geoCodeName, EntityPermission.READ_ONLY);
070    }
071
072    public GeoCode getGeoCodeByNameForUpdate(final ExecutionErrorAccumulator eea, final String geoCodeName) {
073        return getGeoCodeByName(eea, geoCodeName, EntityPermission.READ_WRITE);
074    }
075
076    public GeoCode getGeoCodeByUniversalSpec(final ExecutionErrorAccumulator eea,
077            final GeoCodeUniversalSpec universalSpec, final EntityPermission entityPermission) {
078        GeoCode geoCode = null;
079        var geoControl = Session.getModelController(GeoControl.class);
080        var geoCodeName = universalSpec.getGeoCodeName();
081        var parameterCount = (geoCodeName == null ? 0 : 1) + EntityInstanceLogic.getInstance().countPossibleEntitySpecs(universalSpec);
082
083        switch(parameterCount) {
084            case 1 -> {
085                if(geoCodeName == null) {
086                    var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(eea, universalSpec,
087                            ComponentVendors.ECHO_THREE.name(), EntityTypes.GeoCode.name());
088
089                    if(!eea.hasExecutionErrors()) {
090                        geoCode = geoControl.getGeoCodeByEntityInstance(entityInstance, entityPermission);
091                    }
092                } else {
093                    geoCode = getGeoCodeByName(eea, geoCodeName, entityPermission);
094                }
095            }
096            default ->
097                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
098        }
099
100        return geoCode;
101    }
102
103    public GeoCode getGeoCodeByUniversalSpec(final ExecutionErrorAccumulator eea,
104            final GeoCodeUniversalSpec universalSpec) {
105        return getGeoCodeByUniversalSpec(eea, universalSpec, EntityPermission.READ_ONLY);
106    }
107
108    public GeoCode getGeoCodeByUniversalSpecForUpdate(final ExecutionErrorAccumulator eea,
109            final GeoCodeUniversalSpec universalSpec) {
110        return getGeoCodeByUniversalSpec(eea, universalSpec, EntityPermission.READ_WRITE);
111    }
112
113    public GeoCode getGeoCodeByAlias(final ExecutionErrorAccumulator eea, final GeoCodeType geoCodeType, final GeoCodeScope geoCodeScope,
114            final String geoCodeAliasTypeName, final String alias) {
115        var geoControl = Session.getModelController(GeoControl.class);
116        var geoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(geoCodeType, geoCodeAliasTypeName);
117        GeoCodeAlias geoCodeAlias = null;
118
119        if(geoCodeAliasType != null) {
120            geoCodeAlias = geoControl.getGeoCodeAliasByAliasWithinScope(geoCodeScope, geoCodeAliasType, alias);
121        } else {
122            handleExecutionError(UnknownGeoCodeAliasTypeNameException.class, eea, ExecutionErrors.UnknownGeoCodeAliasTypeName.name(),
123                    geoCodeType.getLastDetail().getGeoCodeTypeName(), geoCodeAliasTypeName);
124        }
125
126        return geoCodeAlias == null ? null : geoCodeAlias.getGeoCode();
127    }
128
129    public void deleteGeoCode(final ExecutionErrorAccumulator eea, final GeoCode geoCode, final BasePK deletedBy) {
130        var contactControl = Session.getModelController(ContactControl.class);
131        var geoControl = Session.getModelController(GeoControl.class);
132        var itemControl = Session.getModelController(ItemControl.class);
133        var selectorControl = Session.getModelController(SelectorControl.class);
134        var taxControl = Session.getModelController(TaxControl.class);
135
136        if(contactControl.countContactPostalAddressCorrectionsByCityGeoCode(geoCode) == 0
137                && contactControl.countContactPostalAddressCorrectionsByCountyGeoCode(geoCode) == 0
138                && contactControl.countContactPostalAddressCorrectionsByStateGeoCode(geoCode) == 0
139                && contactControl.countContactPostalAddressCorrectionsByPostalCodeGeoCode(geoCode) == 0
140                && contactControl.countContactPostalAddressCorrectionsByCountryGeoCode(geoCode) == 0
141                && contactControl.countContactTelephonesByCountryGeoCode(geoCode) == 0
142                && geoControl.countGeoCodeRelationshipsByFromGeoCode(geoCode) == 0
143                && itemControl.countItemCountryOfOriginsByCountryGeoCode(geoCode) == 0
144                && selectorControl.countSelectorNodeGeoCodesByGeoCode(geoCode) == 0
145                && taxControl.countGeoCodeTaxesByGeoCode(geoCode) == 0) {
146
147            geoControl.deleteGeoCode(geoCode, deletedBy);
148        } else {
149            handleExecutionError(null, eea, ExecutionErrors.CannotDeleteGeoCodeInUse.name(),
150                    geoCode.getLastDetail().getGeoCodeName());
151        }
152    }
153
154}