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.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.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.validation.FieldDefinition;
030import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import java.util.Collection;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class GetCountriesCommand
041        extends BasePaginatedMultipleEntitiesCommand<GeoCode, GetCountriesForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.CUSTOMER.name(), null),
050                new PartyTypeDefinition(PartyTypes.VENDOR.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.Country.name(), SecurityRoles.List.name())
053                ))
054        ));
055
056        FORM_FIELD_DEFINITIONS = List.of();
057    }
058
059    /** Creates a new instance of GetCountriesCommand */
060    public GetCountriesCommand() {
061        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
062    }
063
064    @Inject
065    GeoControl geoControl;
066
067    GeoCodeScope countriesGeoCodeScope;
068
069    @Override
070    protected void handleForm() {
071        countriesGeoCodeScope = geoControl.getCountriesGeoCodeScope();
072    }
073
074    @Override
075    protected Long getTotalEntities() {
076        return countriesGeoCodeScope == null ? null : geoControl.countGeoCodesByGeoCodeScope(countriesGeoCodeScope);
077    }
078
079    @Override
080    protected Collection<GeoCode> getEntities() {
081        return countriesGeoCodeScope == null ? null : geoControl.getCountries(countriesGeoCodeScope);
082    }
083
084    @Override
085    protected BaseResult getResult(Collection<GeoCode> entities) {
086        var result = GeoResultFactory.getGetCountriesResult();
087
088        if(entities != null) {
089            if(session.hasLimit(GeoCodeFactory.class)) {
090                result.setCountryCount(getTotalEntities());
091            }
092
093            result.setCountries(geoControl.getCountryTransfers(getUserVisit(), entities));
094        }
095
096        return result;
097    }
098
099}