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