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 com.echothree.util.server.persistence.Session;
039import java.util.List;
040import javax.enterprise.context.Dependent;
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    /** Creates a new instance of GetCountyCommand */
067    public GetCountyCommand() {
068        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
069    }
070
071    @Override
072    protected GeoCode getEntity() {
073        GeoCode geoCode = null;
074        var countyName = form.getCountyName();
075        var countyNumber = form.getCountyNumber();
076        var parameterCount = (countyName == null ? 0 : 1) + (countyNumber == null ? 0 : 1);
077
078        if(parameterCount == 1) {
079            var geoControl = Session.getModelController(GeoControl.class);
080            var createdBy = getPartyPK();
081
082            var stateGeoCodeName = form.getStateGeoCodeName();
083            var stateGeoCode = geoControl.getGeoCodeByName(stateGeoCodeName);
084
085            var stateGeoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(stateGeoCode.getLastDetail().getGeoCodeType(), GeoCodeAliasTypes.POSTAL_2_LETTER.name());
086            var stateGeoCodeAlias = geoControl.getGeoCodeAlias(stateGeoCode, stateGeoCodeAliasType);
087            var statePostal2Letter = stateGeoCodeAlias.getAlias();
088
089            var countryGeoCodeType = geoControl.getGeoCodeTypeByName(GeoCodeTypes.COUNTRY.name());
090            GeoCode countryGeoCode = null;
091            var stateRelationships = geoControl.getGeoCodeRelationshipsByFromGeoCode(stateGeoCode);
092            for(var geoCodeRelationship : stateRelationships) {
093                var toGeoCode = geoCodeRelationship.getToGeoCode();
094                if(toGeoCode.getLastDetail().getGeoCodeType().equals(countryGeoCodeType)) {
095                    countryGeoCode = toGeoCode;
096                    break;
097                }
098            }
099
100            var countryGeoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(countryGeoCode.getLastDetail().getGeoCodeType(), GeoCodeAliasTypes.ISO_2_LETTER.name());
101            var countryGeoCodeAlias = geoControl.getGeoCodeAlias(countryGeoCode, countryGeoCodeAliasType);
102            var countryIso2Letter = countryGeoCodeAlias.getAlias();
103
104            var geoCodeScopeName = countryIso2Letter + "_" + statePostal2Letter + "_COUNTIES";
105            var geoCodeScope = geoControl.getGeoCodeScopeByName(geoCodeScopeName);
106            if(geoCodeScope == null) {
107                geoCodeScope = geoControl.createGeoCodeScope(geoCodeScopeName, false, 0, createdBy);
108            }
109
110            if(geoCodeScope != null) {
111                var geoCodeType = geoControl.getGeoCodeTypeByName(GeoCodeTypes.COUNTY.name());
112                GeoCodeAlias geoCodeAlias;
113
114                if(countyName != null) {
115                    var geoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(geoCodeType, GeoCodeAliasTypes.COUNTY_NAME.name());
116                    geoCodeAlias = geoControl.getGeoCodeAliasByAliasWithinScope(geoCodeScope, geoCodeAliasType, countyName);
117
118                    if(geoCodeAlias == null) {
119                        addExecutionError(ExecutionErrors.UnknownCountyName.name(), countyName);
120                    }
121                } else {
122                    var geoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(geoCodeType, GeoCodeAliasTypes.COUNTY_NUMBER.name());
123                    geoCodeAlias = geoControl.getGeoCodeAliasByAliasWithinScope(geoCodeScope, geoCodeAliasType, countyNumber);
124
125                    if(geoCodeAlias == null) {
126                        addExecutionError(ExecutionErrors.UnknownCountyNumber.name());
127                    }
128                }
129
130                if(geoCodeAlias != null) {
131                    geoCode = geoCodeAlias.getGeoCode();
132
133                    sendEvent(geoCode.getPrimaryKey(), EventTypes.READ, null, null, createdBy);
134                }
135            } else {
136                addExecutionError(ExecutionErrors.UnknownGeoCodeScopeName.name(), geoCodeScopeName);
137            }
138        } else {
139            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
140        }
141
142        return geoCode;
143    }
144
145    @Override
146    protected BaseResult getResult(GeoCode entity) {
147        var result = GeoResultFactory.getGetCountyResult();
148
149        if(entity != null) {
150            var geoControl = Session.getModelController(GeoControl.class);
151
152            result.setCounty(geoControl.getCountyTransfer(getUserVisit(), entity));
153        }
154
155        return result;
156    }
157
158}