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.GetCountyForm;
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.model.data.geo.server.entity.GeoCodeAlias;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.server.control.BaseSingleEntityCommand;
035import com.echothree.util.server.control.CommandSecurityDefinition;
036import com.echothree.util.server.control.PartyTypeDefinition;
037import com.echothree.util.server.control.SecurityRoleDefinition;
038import java.util.List;
039import javax.enterprise.context.Dependent;
040import javax.inject.Inject;
041
042@Dependent
043public class GetCountyCommand
044        extends BaseSingleEntityCommand<GeoCode, GetCountyForm> {
045    
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048    
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.CUSTOMER.name(), null),
053                new PartyTypeDefinition(PartyTypes.VENDOR.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.County.name(), SecurityRoles.Review.name())
056                ))
057        ));
058        
059        FORM_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("StateGeoCodeName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("CountyName", FieldType.ENTITY_NAME, false, null, null),
062                new FieldDefinition("CountyNumber", FieldType.NUMBER_3, false, null, null)
063        );
064    }
065
066    @Inject
067    GeoControl geoControl;
068
069    
070    /** Creates a new instance of GetCountyCommand */
071    public GetCountyCommand() {
072        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
073    }
074
075    @Override
076    protected GeoCode getEntity() {
077        GeoCode geoCode = null;
078        var countyName = form.getCountyName();
079        var countyNumber = form.getCountyNumber();
080        var parameterCount = (countyName == null ? 0 : 1) + (countyNumber == null ? 0 : 1);
081
082        if(parameterCount == 1) {
083            var createdBy = getPartyPK();
084
085            var stateGeoCodeName = form.getStateGeoCodeName();
086            var stateGeoCode = geoControl.getGeoCodeByName(stateGeoCodeName);
087
088            var stateGeoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(stateGeoCode.getLastDetail().getGeoCodeType(), GeoCodeAliasTypes.POSTAL_2_LETTER.name());
089            var stateGeoCodeAlias = geoControl.getGeoCodeAlias(stateGeoCode, stateGeoCodeAliasType);
090            var statePostal2Letter = stateGeoCodeAlias.getAlias();
091
092            var countryGeoCodeType = geoControl.getGeoCodeTypeByName(GeoCodeTypes.COUNTRY.name());
093            GeoCode countryGeoCode = null;
094            var stateRelationships = geoControl.getGeoCodeRelationshipsByFromGeoCode(stateGeoCode);
095            for(var geoCodeRelationship : stateRelationships) {
096                var toGeoCode = geoCodeRelationship.getToGeoCode();
097                if(toGeoCode.getLastDetail().getGeoCodeType().equals(countryGeoCodeType)) {
098                    countryGeoCode = toGeoCode;
099                    break;
100                }
101            }
102
103            var countryGeoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(countryGeoCode.getLastDetail().getGeoCodeType(), GeoCodeAliasTypes.ISO_2_LETTER.name());
104            var countryGeoCodeAlias = geoControl.getGeoCodeAlias(countryGeoCode, countryGeoCodeAliasType);
105            var countryIso2Letter = countryGeoCodeAlias.getAlias();
106
107            var geoCodeScopeName = countryIso2Letter + "_" + statePostal2Letter + "_COUNTIES";
108            var geoCodeScope = geoControl.getGeoCodeScopeByName(geoCodeScopeName);
109            if(geoCodeScope == null) {
110                geoCodeScope = geoControl.createGeoCodeScope(geoCodeScopeName, false, 0, createdBy);
111            }
112
113            if(geoCodeScope != null) {
114                var geoCodeType = geoControl.getGeoCodeTypeByName(GeoCodeTypes.COUNTY.name());
115                GeoCodeAlias geoCodeAlias;
116
117                if(countyName != null) {
118                    var geoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(geoCodeType, GeoCodeAliasTypes.COUNTY_NAME.name());
119                    geoCodeAlias = geoControl.getGeoCodeAliasByAliasWithinScope(geoCodeScope, geoCodeAliasType, countyName);
120
121                    if(geoCodeAlias == null) {
122                        addExecutionError(ExecutionErrors.UnknownCountyName.name(), countyName);
123                    }
124                } else {
125                    var geoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(geoCodeType, GeoCodeAliasTypes.COUNTY_NUMBER.name());
126                    geoCodeAlias = geoControl.getGeoCodeAliasByAliasWithinScope(geoCodeScope, geoCodeAliasType, countyNumber);
127
128                    if(geoCodeAlias == null) {
129                        addExecutionError(ExecutionErrors.UnknownCountyNumber.name());
130                    }
131                }
132
133                if(geoCodeAlias != null) {
134                    geoCode = geoCodeAlias.getGeoCode();
135
136                    sendEvent(geoCode.getPrimaryKey(), EventTypes.READ, null, null, createdBy);
137                }
138            } else {
139                addExecutionError(ExecutionErrors.UnknownGeoCodeScopeName.name(), geoCodeScopeName);
140            }
141        } else {
142            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
143        }
144
145        return geoCode;
146    }
147
148    @Override
149    protected BaseResult getResult(GeoCode entity) {
150        var result = GeoResultFactory.getGetCountyResult();
151
152        if(entity != null) {
153            result.setCounty(geoControl.getCountyTransfer(getUserVisit(), entity));
154        }
155
156        return result;
157    }
158
159}