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.GetZipCodeForm;
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 java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
042public class GetZipCodeCommand
043        extends BaseSingleEntityCommand<GeoCode, GetZipCodeForm> {
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.ZipCode.name(), SecurityRoles.Review.name())
055                ))
056        ));
057        
058        FORM_FIELD_DEFINITIONS = List.of(
059                new FieldDefinition("CountryGeoCodeName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("ZipCodeName", FieldType.ENTITY_NAME, true, null, null)
061        );
062    }
063
064    @Inject
065    GeoControl geoControl;
066
067    
068    /** Creates a new instance of GetZipCodeCommand */
069    public GetZipCodeCommand() {
070        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
071    }
072    
073    @Override
074    protected GeoCode getEntity() {
075        GeoCode geoCode = null;
076
077        var countryGeoCodeName = form.getCountryGeoCodeName();
078        var countryGeoCode = geoControl.getGeoCodeByName(countryGeoCodeName);
079
080        var countryGeoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(countryGeoCode.getLastDetail().getGeoCodeType(),
081                GeoCodeAliasTypes.ISO_2_LETTER.name());
082        var countryGeoCodeAlias = geoControl.getGeoCodeAlias(countryGeoCode, countryGeoCodeAliasType);
083        var countryIso2Letter = countryGeoCodeAlias.getAlias();
084
085        var geoCodeScopeName = countryIso2Letter + "_ZIP_CODES";
086        var geoCodeScope = geoControl.getGeoCodeScopeByName(geoCodeScopeName);
087
088        if(geoCodeScope != null) {
089            var geoCodeType = geoControl.getGeoCodeTypeByName(GeoCodeTypes.ZIP_CODE.name());
090            var geoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(geoCodeType, GeoCodeAliasTypes.ZIP_CODE.name());
091            var zipCodeName = form.getZipCodeName();
092            var geoCodeAlias = geoControl.getGeoCodeAliasByAliasWithinScope(geoCodeScope, geoCodeAliasType, zipCodeName);
093
094            if(geoCodeAlias != null) {
095                geoCode = geoCodeAlias.getGeoCode();
096
097                sendEvent(geoCode.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
098            } else {
099                addExecutionError(ExecutionErrors.UnknownZipCodeName.name(), zipCodeName);
100            }
101        } else {
102            addExecutionError(ExecutionErrors.UnknownGeoCodeScopeName.name(), geoCodeScopeName);
103        }
104
105        return geoCode;
106    }
107
108    @Override
109    protected BaseResult getResult(GeoCode entity) {
110        var result = GeoResultFactory.getGetZipCodeResult();
111
112        if(entity != null) {
113            result.setPostalCode(geoControl.getPostalCodeTransfer(getUserVisit(), entity));
114        }
115
116        return result;
117    }
118
119}