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.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.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;
040
041public class GetStatesCommand
042        extends BaseMultipleEntitiesCommand<GeoCode, GetStatesForm> {
043    
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.CUSTOMER.name(), null),
051                new PartyTypeDefinition(PartyTypes.VENDOR.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
053                        new SecurityRoleDefinition(SecurityRoleGroups.State.name(), SecurityRoles.List.name())
054                        )))
055                )));
056
057        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
058                new FieldDefinition("CountryName", FieldType.ENTITY_NAME, true, null, null)
059                ));
060    }
061    
062    /** Creates a new instance of GetStatesCommand */
063    public GetStatesCommand(UserVisitPK userVisitPK, GetStatesForm form) {
064        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
065    }
066
067    GeoCode countryGeoCode;
068
069    @Override
070    protected Collection<GeoCode> getEntities() {
071        var geoControl = Session.getModelController(GeoControl.class);
072        var countryName = form.getCountryName();
073        Collection<GeoCode> stateGeoCodes = null;
074
075        countryGeoCode = geoControl.getCountryByAlias(countryName);
076
077        if(countryGeoCode != null) {
078            stateGeoCodes = geoControl.getStatesByCountry(countryGeoCode);
079        } else {
080            addExecutionError(ExecutionErrors.UnknownCountryName.name(), countryName);
081        }
082
083        return stateGeoCodes;
084    }
085
086    @Override
087    protected BaseResult getResult(Collection<GeoCode> entities) {
088        var result = GeoResultFactory.getGetStatesResult();
089
090        if(entities != null) {
091            var geoControl = Session.getModelController(GeoControl.class);
092            var userVisit = getUserVisit();
093
094            result.setCountry(geoControl.getCountryTransfer(userVisit, countryGeoCode));
095            result.setStates(geoControl.getStateTransfers(userVisit, entities));
096
097        }
098
099        return result;
100    }
101
102}