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.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.geo.server.entity.GeoCodeScope;
027import com.echothree.model.data.geo.server.factory.GeoCodeFactory;
028import com.echothree.model.data.item.server.factory.ItemFactory;
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.BasePaginatedMultipleEntitiesCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import java.util.Collection;
038import java.util.List;
039import javax.enterprise.context.Dependent;
040import javax.inject.Inject;
041
042@Dependent
043public class GetCitiesCommand
044        extends BasePaginatedMultipleEntitiesCommand<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(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.City.name(), SecurityRoles.List.name())
056                        ))
057                ));
058
059        FORM_FIELD_DEFINITIONS = List.of(
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    @Inject
071    GeoControl geoControl;
072
073    GeoCode stateGeoCode;
074    GeoCodeScope citiesGeoCodeScope;
075
076    @Override
077    protected void handleForm() {
078        var countryName = form.getCountryName();
079        var countryGeoCode = geoControl.getCountryByAlias(countryName);
080
081        if(countryGeoCode != null) {
082            var stateName = form.getStateName();
083
084            stateGeoCode = geoControl.getStateByAlias(countryGeoCode, stateName);
085
086            if(stateGeoCode != null) {
087                citiesGeoCodeScope = geoControl.getCitiesGeoCodeScope(stateGeoCode);
088            } else {
089                addExecutionError(ExecutionErrors.UnknownStateName.name(), stateName);
090            }
091        } else {
092            addExecutionError(ExecutionErrors.UnknownCountryName.name(), countryName);
093        }
094    }
095
096    @Override
097    protected Long getTotalEntities() {
098        return citiesGeoCodeScope == null ? null : geoControl.countGeoCodesByGeoCodeScope(citiesGeoCodeScope);
099    }
100
101    @Override
102    protected Collection<GeoCode> getEntities() {
103        return citiesGeoCodeScope == null ? null : geoControl.getCitiesByState(citiesGeoCodeScope);
104    }
105
106    @Override
107    protected BaseResult getResult(Collection<GeoCode> entities) {
108        var result = GeoResultFactory.getGetCitiesResult();
109
110        if(entities != null) {
111            var userVisit = getUserVisit();
112
113            result.setState(geoControl.getStateTransfer(userVisit, stateGeoCode));
114
115            if(session.hasLimit(GeoCodeFactory.class)) {
116                result.setCityCount(getTotalEntities());
117            }
118
119            result.setCities(geoControl.getCityTransfers(getUserVisit(), entities));
120        }
121
122        return result;
123    }
124
125}