001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.shipping.server.command;
018
019import com.echothree.control.user.shipping.common.form.GetShippingMethodsForm;
020import com.echothree.control.user.shipping.common.result.ShippingResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.control.shipping.server.control.ShippingControl;
025import com.echothree.model.data.shipping.server.entity.ShippingMethod;
026import com.echothree.model.data.shipping.server.factory.ShippingMethodFactory;
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;
037import javax.enterprise.context.RequestScoped;
038
039@RequestScoped
040public class GetShippingMethodsCommand
041        extends BaseMultipleEntitiesCommand<ShippingMethod, GetShippingMethodsForm> {
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.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.ShippingMethod.name(), SecurityRoles.List.name())
051                ))
052        ));
053
054        FORM_FIELD_DEFINITIONS = List.of();
055    }
056
057    /** Creates a new instance of GetShippingMethodsCommand */
058    public GetShippingMethodsCommand() {
059        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
060    }
061
062    @Override
063    protected Collection<ShippingMethod> getEntities() {
064        var shippingControl = Session.getModelController(ShippingControl.class);
065
066        return shippingControl.getShippingMethods();
067    }
068
069    @Override
070    protected BaseResult getResult(Collection<ShippingMethod> entities) {
071        var result = ShippingResultFactory.getGetShippingMethodsResult();
072
073        if(entities != null) {
074            var shippingControl = Session.getModelController(ShippingControl.class);
075
076            if(session.hasLimit(ShippingMethodFactory.class)) {
077                result.setShippingMethodCount(shippingControl.countShippingMethods());
078            }
079
080            result.setShippingMethods(shippingControl.getShippingMethodTransfers(getUserVisit(), entities));
081        }
082
083        return result;
084    }
085
086}