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.GetGeoCodeScopesForm;
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.GeoCodeScope;
026import com.echothree.model.data.geo.server.factory.GeoCodeScopeFactory;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.server.control.BaseMultipleEntitiesCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.Collection;
036import java.util.List;
037
038public class GetGeoCodeScopesCommand
039        extends BaseMultipleEntitiesCommand<GeoCodeScope, GetGeoCodeScopesForm> {
040
041    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
042    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
043
044    static {
045        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
046                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
048                        new SecurityRoleDefinition(SecurityRoleGroups.GeoCodeScope.name(), SecurityRoles.List.name())
049                ))
050        ));
051
052        FORM_FIELD_DEFINITIONS = List.of();
053    }
054
055    /** Creates a new instance of GetGeoCodeScopesCommand */
056    public GetGeoCodeScopesCommand(UserVisitPK userVisitPK, GetGeoCodeScopesForm form) {
057        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
058    }
059
060    @Override
061    protected Collection<GeoCodeScope> getEntities() {
062        var geoControl = Session.getModelController(GeoControl.class);
063
064        return geoControl.getGeoCodeScopes();
065    }
066
067    @Override
068    protected BaseResult getResult(Collection<GeoCodeScope> entities) {
069        var result = GeoResultFactory.getGetGeoCodeScopesResult();
070
071        if(entities != null) {
072            var geoControl = Session.getModelController(GeoControl.class);
073
074            if(session.hasLimit(GeoCodeScopeFactory.class)) {
075                result.setGeoCodeScopeCount(geoControl.countGeoCodeScopes());
076            }
077
078            result.setGeoCodeScopes(geoControl.getGeoCodeScopeTransfers(getUserVisit(), entities));
079        }
080
081        return result;
082    }
083
084}