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.GetCountriesForm;
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.validation.FieldDefinition;
029import com.echothree.util.server.control.BaseMultipleEntitiesCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import com.echothree.util.server.persistence.Session;
034import java.util.Arrays;
035import java.util.Collection;
036import java.util.Collections;
037import java.util.List;
038
039public class GetCountriesCommand
040        extends BaseMultipleEntitiesCommand<GeoCode, GetCountriesForm> {
041    
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.CUSTOMER.name(), null),
049                new PartyTypeDefinition(PartyTypes.VENDOR.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
051                        new SecurityRoleDefinition(SecurityRoleGroups.Country.name(), SecurityRoles.List.name())
052                        )))
053                )));
054
055        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
056                ));
057    }
058
059    /** Creates a new instance of GetCountriesCommand */
060    public GetCountriesCommand(UserVisitPK userVisitPK, GetCountriesForm form) {
061        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
062    }
063
064    @Override
065    protected Collection<GeoCode> getEntities() {
066        var geoControl = Session.getModelController(GeoControl.class);
067
068        return geoControl.getCountries();
069    }
070
071    @Override
072    protected BaseResult getResult(Collection<GeoCode> entities) {
073        var result = GeoResultFactory.getGetCountriesResult();
074
075        if(entities != null) {
076            var geoControl = Session.getModelController(GeoControl.class);
077
078            result.setCountries(geoControl.getCountryTransfers(getUserVisit(), entities));
079        }
080
081        return result;
082    }
083
084}