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.GetStatesForm;
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.util.common.command.BaseResult;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.Collection;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
042public class GetStatesCommand
043        extends BasePaginatedMultipleEntitiesCommand<GeoCode, GetStatesForm> {
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.State.name(), SecurityRoles.List.name())
055                ))
056        ));
057
058        FORM_FIELD_DEFINITIONS = List.of(
059                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null)
060        );
061    }
062
063    @Inject
064    GeoControl geoControl;
065
066    
067    /** Creates a new instance of GetStatesCommand */
068    public GetStatesCommand() {
069        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
070    }
071
072    GeoCode countryGeoCode;
073    GeoCodeScope statesGeoCodeScope;
074
075    @Override
076    protected void handleForm() {
077        var countryName = form.getCountryName();
078
079        countryGeoCode = geoControl.getCountryByAlias(countryName);
080
081        if(countryGeoCode != null) {
082            statesGeoCodeScope = geoControl.getStatesGeoCodeScope(countryGeoCode);
083        } else {
084            addExecutionError(ExecutionErrors.UnknownCountryName.name(), countryName);
085        }
086    }
087
088    @Override
089    protected Long getTotalEntities() {
090        return statesGeoCodeScope == null ? null : geoControl.countGeoCodesByGeoCodeScope(statesGeoCodeScope);
091    }
092
093    @Override
094    protected Collection<GeoCode> getEntities() {
095        return statesGeoCodeScope == null ? null : geoControl.getStatesByCountry(statesGeoCodeScope);
096    }
097
098    @Override
099    protected BaseResult getResult(Collection<GeoCode> entities) {
100        var result = GeoResultFactory.getGetStatesResult();
101
102        if(entities != null) {
103            var userVisit = getUserVisit();
104
105            result.setCountry(geoControl.getCountryTransfer(userVisit, countryGeoCode));
106
107            if(session.hasLimit(GeoCodeFactory.class)) {
108                result.setStateCount(getTotalEntities());
109            }
110
111            result.setStates(geoControl.getStateTransfers(userVisit, entities));
112        }
113
114        return result;
115    }
116
117}