001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.GeoConstants;
023import com.echothree.model.control.geo.server.control.GeoControl;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.geo.server.entity.GeoCode;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
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;
041
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(Collections.unmodifiableList(Arrays.asList(
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(), Collections.unmodifiableList(Arrays.asList(
054                        new SecurityRoleDefinition(SecurityRoleGroups.ZipCode.name(), SecurityRoles.Review.name())
055                        )))
056                )));
057        
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("CountryGeoCodeName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("ZipCodeName", FieldType.ENTITY_NAME, true, null, null)
061                ));
062    }
063    
064    /** Creates a new instance of GetZipCodeCommand */
065    public GetZipCodeCommand(UserVisitPK userVisitPK, GetZipCodeForm form) {
066        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
067    }
068    
069    @Override
070    protected GeoCode getEntity() {
071        var geoControl = Session.getModelController(GeoControl.class);
072        GeoCode geoCode = null;
073
074        var countryGeoCodeName = form.getCountryGeoCodeName();
075        var countryGeoCode = geoControl.getGeoCodeByName(countryGeoCodeName);
076
077        var countryGeoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(countryGeoCode.getLastDetail().getGeoCodeType(),
078                GeoConstants.GeoCodeAliasType_ISO_2_LETTER);
079        var countryGeoCodeAlias = geoControl.getGeoCodeAlias(countryGeoCode, countryGeoCodeAliasType);
080        var countryIso2Letter = countryGeoCodeAlias.getAlias();
081
082        var geoCodeScopeName = countryIso2Letter + "_ZIP_CODES";
083        var geoCodeScope = geoControl.getGeoCodeScopeByName(geoCodeScopeName);
084
085        if(geoCodeScope != null) {
086            var geoCodeType = geoControl.getGeoCodeTypeByName(GeoConstants.GeoCodeType_ZIP_CODE);
087            var geoCodeAliasType = geoControl.getGeoCodeAliasTypeByName(geoCodeType, GeoConstants.GeoCodeAliasType_ZIP_CODE);
088            var zipCodeName = form.getZipCodeName();
089            var geoCodeAlias = geoControl.getGeoCodeAliasByAliasWithinScope(geoCodeScope, geoCodeAliasType, zipCodeName);
090
091            if(geoCodeAlias != null) {
092                geoCode = geoCodeAlias.getGeoCode();
093
094                sendEvent(geoCode.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
095            } else {
096                addExecutionError(ExecutionErrors.UnknownZipCodeName.name(), zipCodeName);
097            }
098        } else {
099            addExecutionError(ExecutionErrors.UnknownGeoCodeScopeName.name(), geoCodeScopeName);
100        }
101
102        return geoCode;
103    }
104
105    @Override
106    protected BaseResult getResult(GeoCode entity) {
107        var result = GeoResultFactory.getGetZipCodeResult();
108
109        if(entity != null) {
110            var geoControl = Session.getModelController(GeoControl.class);
111
112            result.setPostalCode(geoControl.getPostalCodeTransfer(getUserVisit(), entity));
113        }
114
115        return result;
116    }
117
118}