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.GetShippingMethodChoicesForm;
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.shipment.server.control.ShipmentControl;
025import com.echothree.model.control.shipping.server.control.ShippingControl;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
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.Arrays;
036import java.util.Collections;
037import java.util.List;
038import javax.enterprise.context.RequestScoped;
039
040@RequestScoped
041public class GetShippingMethodChoicesCommand
042        extends BaseSimpleCommand<GetShippingMethodChoicesForm> {
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.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
050                        new SecurityRoleDefinition(SecurityRoleGroups.ShippingMethod.name(), SecurityRoles.Choices.name())
051                        )))
052                )));
053
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055                new FieldDefinition("ShipmentTypeName", FieldType.ENTITY_NAME, false, null, null),
056                new FieldDefinition("DefaultShippingMethodChoice", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
058                ));
059    }
060    
061    /** Creates a new instance of GetShippingMethodChoicesCommand */
062    public GetShippingMethodChoicesCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var shipmentControl = Session.getModelController(ShipmentControl.class);
069        var shippingControl = Session.getModelController(ShippingControl.class);
070        var result = ShippingResultFactory.getGetShippingMethodChoicesResult();
071        var shipmentTypeName = form.getShipmentTypeName();
072        var shipmentType = shipmentTypeName == null? null: shipmentControl.getShipmentTypeByName(shipmentTypeName);
073        
074        if(shipmentTypeName == null || shipmentType != null) {
075            var defaultShippingMethodChoice = form.getDefaultShippingMethodChoice();
076            var allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
077            
078            if(shipmentType == null) {
079                result.setShippingMethodChoices(shippingControl.getShippingMethodChoices(defaultShippingMethodChoice,
080                        getPreferredLanguage(), allowNullChoice));
081            } else {
082                result.setShippingMethodChoices(shippingControl.getShippingMethodChoices(defaultShippingMethodChoice,
083                        getPreferredLanguage(), allowNullChoice, shipmentType));
084            }
085        } else {
086            addExecutionError(ExecutionErrors.UnknownShipmentTypeName.name(), shipmentTypeName);
087        }
088        
089        return result;
090    }
091    
092}