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.GetCitiesForm;
020import com.echothree.control.user.geo.common.result.GeoResultFactory;
021import com.echothree.model.control.geo.server.control.GeoControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.geo.server.entity.GeoCode;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.server.control.BaseMultipleEntitiesCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.Arrays;
037import java.util.Collection;
038import java.util.Collections;
039import java.util.List;
040import javax.enterprise.context.RequestScoped;
041
042@RequestScoped
043public class GetCitiesCommand
044        extends BaseMultipleEntitiesCommand<GeoCode, GetCitiesForm> {
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(Collections.unmodifiableList(Arrays.asList(
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(), Collections.unmodifiableList(Arrays.asList(
055                        new SecurityRoleDefinition(SecurityRoleGroups.City.name(), SecurityRoles.List.name())
056                        )))
057                )));
058
059        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
060                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("StateName", FieldType.ENTITY_NAME, true, null, null)
062                ));
063    }
064    
065    /** Creates a new instance of GetCitiesCommand */
066    public GetCitiesCommand() {
067        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
068    }
069
070    GeoCode stateGeoCode;
071
072    @Override
073    protected Collection<GeoCode> getEntities() {
074        var geoControl = Session.getModelController(GeoControl.class);
075        var countryName = form.getCountryName();
076        var countryGeoCode = geoControl.getCountryByAlias(countryName);
077        Collection<GeoCode> cityGeoCodes = null;
078
079        if(countryGeoCode != null) {
080            var stateName = form.getStateName();
081
082            stateGeoCode = geoControl.getStateByAlias(countryGeoCode, stateName);
083
084            if(stateGeoCode != null) {
085                cityGeoCodes = geoControl.getCitiesByState(stateGeoCode);
086            } else {
087                addExecutionError(ExecutionErrors.UnknownStateName.name(), stateName);
088            }
089        } else {
090            addExecutionError(ExecutionErrors.UnknownCountryName.name(), countryName);
091        }
092
093        return cityGeoCodes;
094    }
095
096    @Override
097    protected BaseResult getResult(Collection<GeoCode> entities) {
098        var result = GeoResultFactory.getGetCitiesResult();
099
100        if(entities != null) {
101            var geoControl = Session.getModelController(GeoControl.class);
102            var userVisit = getUserVisit();
103
104            result.setState(geoControl.getStateTransfer(userVisit, stateGeoCode));
105            result.setCities(geoControl.getCityTransfers(getUserVisit(), entities));
106        }
107
108        return result;
109    }
110
111}