001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.control.user.geo.server.command;
018
019import com.echothree.control.user.geo.common.form.GetCityForm;
020import com.echothree.control.user.geo.common.result.GeoResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
022import com.echothree.model.control.geo.common.GeoCodeAliasTypes;
023import com.echothree.model.control.geo.common.GeoCodeTypes;
024import com.echothree.model.control.geo.server.control.GeoControl;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.data.geo.server.entity.GeoCode;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BaseSingleEntityCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import com.echothree.util.server.persistence.Session;
038import java.util.List;
039import javax.enterprise.context.Dependent;
040
041@Dependent
042public class GetCityCommand
043        extends BaseSingleEntityCommand<GeoCode, GetCityForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.CUSTOMER.name(), null),
052                new PartyTypeDefinition(PartyTypes.VENDOR.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
054                        new SecurityRoleDefinition(SecurityRoleGroups.City.name(), SecurityRoles.Review.name())
055                        ))
056                ));
057        
058        FORM_FIELD_DEFINITIONS = List.of(
059                new FieldDefinition("StateGeoCodeName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("CityName", FieldType.ENTITY_NAME, true, null, null)
061                );
062    }
063    
064    /** Creates a new instance of GetCityCommand */
065    public GetCityCommand() {
066        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
067    }
068
069    @Override
070    protected GeoCode getEntity() {
071        var geoControl = Session.getModelController(GeoControl.class);
072        var createdBy = getPartyPK();
073        GeoCode geoCode = null;
074
075        var stateGeoCodeName = form.getStateGeoCodeName();
076        var stateGeoCode = geoControl.getGeoCodeByName(stateGeoCodeName);
077
078        var stateGeoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(stateGeoCode.getLastDetail().getGeoCodeType(), GeoCodeAliasTypes.POSTAL_2_LETTER.name());
079        var stateGeoCodeAlias = geoControl.getGeoCodeAlias(stateGeoCode, stateGeoCodeAliasType);
080        var statePostal2Letter = stateGeoCodeAlias.getAlias();
081
082        var countryGeoCodeType = geoControl.getGeoCodeTypeByName(GeoCodeTypes.COUNTRY.name());
083        GeoCode countryGeoCode = null;
084        var stateRelationships = geoControl.getGeoCodeRelationshipsByFromGeoCode(stateGeoCode);
085        for(var geoCodeRelationship : stateRelationships) {
086            var toGeoCode = geoCodeRelationship.getToGeoCode();
087            if(toGeoCode.getLastDetail().getGeoCodeType().equals(countryGeoCodeType)) {
088                countryGeoCode = toGeoCode;
089                break;
090            }
091        }
092
093        var countryGeoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(countryGeoCode.getLastDetail().getGeoCodeType(), GeoCodeAliasTypes.ISO_2_LETTER.name());
094        var countryGeoCodeAlias = geoControl.getGeoCodeAlias(countryGeoCode, countryGeoCodeAliasType);
095        var countryIso2Letter = countryGeoCodeAlias.getAlias();
096
097        var geoCodeScopeName = countryIso2Letter + "_" + statePostal2Letter + "_CITIES";
098        var geoCodeScope = geoControl.getGeoCodeScopeByName(geoCodeScopeName);
099        if(geoCodeScope == null) {
100            geoCodeScope = geoControl.createGeoCodeScope(geoCodeScopeName, false, 0, createdBy);
101        }
102
103        var geoCodeType = geoControl.getGeoCodeTypeByName(GeoCodeTypes.CITY.name());
104        var geoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(geoCodeType, GeoCodeAliasTypes.CITY_NAME.name());
105        var cityName = form.getCityName();
106        var geoCodeAlias = geoControl.getGeoCodeAliasByAliasWithinScope(geoCodeScope, geoCodeAliasType, cityName);
107
108        if(geoCodeAlias != null) {
109            geoCode = geoCodeAlias.getGeoCode();
110
111            sendEvent(geoCode.getPrimaryKey(), EventTypes.READ, null, null, createdBy);
112        } else {
113            addExecutionError(ExecutionErrors.UnknownCityName.name());
114        }
115
116        return geoCode;
117    }
118
119    @Override
120    protected BaseResult getResult(GeoCode entity) {
121        var result = GeoResultFactory.getGetCityResult();
122
123        if(entity != null) {
124            var geoControl = Session.getModelController(GeoControl.class);
125
126            result.setCity(geoControl.getCityTransfer(getUserVisit(), entity));
127        }
128
129        return result;
130    }
131
132}