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.GetShippingMethodCarrierServicesForm;
020import com.echothree.control.user.shipping.common.result.ShippingResultFactory;
021import com.echothree.model.control.carrier.server.control.CarrierControl;
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.control.shipping.server.control.ShippingControl;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039import javax.enterprise.context.RequestScoped;
040
041@RequestScoped
042public class GetShippingMethodCarrierServicesCommand
043        extends BaseSimpleCommand<GetShippingMethodCarrierServicesForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                        new SecurityRoleDefinition(SecurityRoleGroups.ShippingMethodCarrierService.name(), SecurityRoles.List.name())
053                        )))
054                )));
055    }
056
057    static {
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("ShippingMethodName", FieldType.ENTITY_NAME, false, null, null),
060                new FieldDefinition("CarrierName", FieldType.ENTITY_NAME, false, null, null),
061                new FieldDefinition("CarrierServiceName", FieldType.ENTITY_NAME, false, null, null)
062                ));
063    }
064    
065    /** Creates a new instance of GetShippingMethodCarrierServicesCommand */
066    public GetShippingMethodCarrierServicesCommand() {
067        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
068    }
069    
070    @Override
071    protected BaseResult execute() {
072        var shippingControl = Session.getModelController(ShippingControl.class);
073        var result = ShippingResultFactory.getGetShippingMethodCarrierServicesResult();
074        var shippingMethodName = form.getShippingMethodName();
075        var carrierName = form.getCarrierName();
076        var carrierServiceName = form.getCarrierServiceName();
077        
078        if(shippingMethodName != null && carrierName == null && carrierServiceName == null) {
079            var shippingMethod = shippingControl.getShippingMethodByName(shippingMethodName);
080            
081            if(shippingMethod != null) {
082                result.setShippingMethod(shippingControl.getShippingMethodTransfer(getUserVisit(), shippingMethod));
083                result.setShippingMethodCarrierServices(shippingControl.getShippingMethodCarrierServiceTransfersByShippingMethod(getUserVisit(),
084                        shippingMethod));
085            } else {
086                addExecutionError(ExecutionErrors.UnknownShippingMethodName.name(), shippingMethodName);
087            }
088        } else if(shippingMethodName == null && carrierName != null && carrierServiceName != null) {
089            var carrierControl = Session.getModelController(CarrierControl.class);
090            var carrier = carrierControl.getCarrierByName(carrierName);
091            
092            if(carrier != null) {
093                var carrierParty = carrier.getParty();
094                var carrierService = carrierControl.getCarrierServiceByName(carrierParty, carrierServiceName);
095                
096                if(carrierService != null) {
097                    result.setCarrierService(carrierControl.getCarrierServiceTransfer(getUserVisit(), carrierService));
098                    result.setShippingMethodCarrierServices(shippingControl.getShippingMethodCarrierServiceTransfersByCarrierService(getUserVisit(),
099                            carrierService));
100                } else {
101                    addExecutionError(ExecutionErrors.UnknownCarrierServiceName.name(), carrierServiceName);
102                }
103            } else {
104                addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName);
105            }
106            
107        } else {
108            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
109        }
110        
111        return result;
112    }
113    
114}