001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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;
041
042public class GeoCodeLogic
043        extends BaseLogic {
044
045    private GeoCodeLogic() {
046        super();
047    }
048
049    private static class GeoCodeLogicHolder {
050        static GeoCodeLogic instance = new GeoCodeLogic();
051    }
052
053    public static GeoCodeLogic getInstance() {
054        return GeoCodeLogicHolder.instance;
055    }
056
057    public GeoCode getGeoCodeByName(final ExecutionErrorAccumulator eea, final String geoCodeName,
058            final EntityPermission entityPermission) {
059        var geoControl = Session.getModelController(GeoControl.class);
060        var geoCode = geoControl.getGeoCodeByName(geoCodeName, entityPermission);
061
062        if(geoCode == null) {
063            handleExecutionError(UnknownGeoCodeNameException.class, eea, ExecutionErrors.UnknownGeoCodeName.name(), geoCodeName);
064        }
065
066        return geoCode;
067    }
068
069    public GeoCode getGeoCodeByName(final ExecutionErrorAccumulator eea, final String geoCodeName) {
070        return getGeoCodeByName(eea, geoCodeName, EntityPermission.READ_ONLY);
071    }
072
073    public GeoCode getGeoCodeByNameForUpdate(final ExecutionErrorAccumulator eea, final String geoCodeName) {
074        return getGeoCodeByName(eea, geoCodeName, EntityPermission.READ_WRITE);
075    }
076
077    public GeoCode getGeoCodeByUniversalSpec(final ExecutionErrorAccumulator eea,
078            final GeoCodeUniversalSpec universalSpec, final EntityPermission entityPermission) {
079        GeoCode geoCode = null;
080        var geoControl = Session.getModelController(GeoControl.class);
081        var geoCodeName = universalSpec.getGeoCodeName();
082        var parameterCount = (geoCodeName == null ? 0 : 1) + EntityInstanceLogic.getInstance().countPossibleEntitySpecs(universalSpec);
083
084        switch(parameterCount) {
085            case 1 -> {
086                if(geoCodeName == null) {
087                    var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(eea, universalSpec,
088                            ComponentVendors.ECHO_THREE.name(), EntityTypes.GeoCode.name());
089
090                    if(!eea.hasExecutionErrors()) {
091                        geoCode = geoControl.getGeoCodeByEntityInstance(entityInstance, entityPermission);
092                    }
093                } else {
094                    geoCode = getGeoCodeByName(eea, geoCodeName, entityPermission);
095                }
096            }
097            default ->
098                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
099        }
100
101        return geoCode;
102    }
103
104    public GeoCode getGeoCodeByUniversalSpec(final ExecutionErrorAccumulator eea,
105            final GeoCodeUniversalSpec universalSpec) {
106        return getGeoCodeByUniversalSpec(eea, universalSpec, EntityPermission.READ_ONLY);
107    }
108
109    public GeoCode getGeoCodeByUniversalSpecForUpdate(final ExecutionErrorAccumulator eea,
110            final GeoCodeUniversalSpec universalSpec) {
111        return getGeoCodeByUniversalSpec(eea, universalSpec, EntityPermission.READ_WRITE);
112    }
113
114    public GeoCode getGeoCodeByAlias(final ExecutionErrorAccumulator eea, final GeoCodeType geoCodeType, final GeoCodeScope geoCodeScope,
115            final String geoCodeAliasTypeName, final String alias) {
116        var geoControl = Session.getModelController(GeoControl.class);
117        var geoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(geoCodeType, geoCodeAliasTypeName);
118        GeoCodeAlias geoCodeAlias = null;
119
120        if(geoCodeAliasType != null) {
121            geoCodeAlias = geoControl.getGeoCodeAliasByAliasWithinScope(geoCodeScope, geoCodeAliasType, alias);
122        } else {
123            handleExecutionError(UnknownGeoCodeAliasTypeNameException.class, eea, ExecutionErrors.UnknownGeoCodeAliasTypeName.name(),
124                    geoCodeType.getLastDetail().getGeoCodeTypeName(), geoCodeAliasTypeName);
125        }
126
127        return geoCodeAlias == null ? null : geoCodeAlias.getGeoCode();
128    }
129
130    public void deleteGeoCode(final ExecutionErrorAccumulator eea, final GeoCode geoCode, final BasePK deletedBy) {
131        var contactControl = Session.getModelController(ContactControl.class);
132        var geoControl = Session.getModelController(GeoControl.class);
133        var itemControl = Session.getModelController(ItemControl.class);
134        var selectorControl = Session.getModelController(SelectorControl.class);
135        var taxControl = Session.getModelController(TaxControl.class);
136
137        if(contactControl.countContactPostalAddressCorrectionsByCityGeoCode(geoCode) == 0
138                && contactControl.countContactPostalAddressCorrectionsByCountyGeoCode(geoCode) == 0
139                && contactControl.countContactPostalAddressCorrectionsByStateGeoCode(geoCode) == 0
140                && contactControl.countContactPostalAddressCorrectionsByPostalCodeGeoCode(geoCode) == 0
141                && contactControl.countContactPostalAddressCorrectionsByCountryGeoCode(geoCode) == 0
142                && contactControl.countContactTelephonesByCountryGeoCode(geoCode) == 0
143                && geoControl.countGeoCodeRelationshipsByFromGeoCode(geoCode) == 0
144                && itemControl.countItemCountryOfOriginsByCountryGeoCode(geoCode) == 0
145                && selectorControl.countSelectorNodeGeoCodesByGeoCode(geoCode) == 0
146                && taxControl.countGeoCodeTaxesByGeoCode(geoCode) == 0) {
147
148            geoControl.deleteGeoCode(geoCode, deletedBy);
149        } else {
150            handleExecutionError(null, eea, ExecutionErrors.CannotDeleteGeoCodeInUse.name(),
151                    geoCode.getLastDetail().getGeoCodeName());
152        }
153    }
154
155}