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.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.List;
037import javax.enterprise.context.Dependent;
038
039@Dependent
040public class GetShippingMethodCarrierServicesCommand
041        extends BaseSimpleCommand<GetShippingMethodCarrierServicesForm> {
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.ShippingMethodCarrierService.name(), SecurityRoles.List.name())
051                        ))
052                ));
053    }
054
055    static {
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("ShippingMethodName", FieldType.ENTITY_NAME, false, null, null),
058                new FieldDefinition("CarrierName", FieldType.ENTITY_NAME, false, null, null),
059                new FieldDefinition("CarrierServiceName", FieldType.ENTITY_NAME, false, null, null)
060                );
061    }
062    
063    /** Creates a new instance of GetShippingMethodCarrierServicesCommand */
064    public GetShippingMethodCarrierServicesCommand() {
065        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        var shippingControl = Session.getModelController(ShippingControl.class);
071        var result = ShippingResultFactory.getGetShippingMethodCarrierServicesResult();
072        var shippingMethodName = form.getShippingMethodName();
073        var carrierName = form.getCarrierName();
074        var carrierServiceName = form.getCarrierServiceName();
075        
076        if(shippingMethodName != null && carrierName == null && carrierServiceName == null) {
077            var shippingMethod = shippingControl.getShippingMethodByName(shippingMethodName);
078            
079            if(shippingMethod != null) {
080                result.setShippingMethod(shippingControl.getShippingMethodTransfer(getUserVisit(), shippingMethod));
081                result.setShippingMethodCarrierServices(shippingControl.getShippingMethodCarrierServiceTransfersByShippingMethod(getUserVisit(),
082                        shippingMethod));
083            } else {
084                addExecutionError(ExecutionErrors.UnknownShippingMethodName.name(), shippingMethodName);
085            }
086        } else if(shippingMethodName == null && carrierName != null && carrierServiceName != null) {
087            var carrierControl = Session.getModelController(CarrierControl.class);
088            var carrier = carrierControl.getCarrierByName(carrierName);
089            
090            if(carrier != null) {
091                var carrierParty = carrier.getParty();
092                var carrierService = carrierControl.getCarrierServiceByName(carrierParty, carrierServiceName);
093                
094                if(carrierService != null) {
095                    result.setCarrierService(carrierControl.getCarrierServiceTransfer(getUserVisit(), carrierService));
096                    result.setShippingMethodCarrierServices(shippingControl.getShippingMethodCarrierServiceTransfersByCarrierService(getUserVisit(),
097                            carrierService));
098                } else {
099                    addExecutionError(ExecutionErrors.UnknownCarrierServiceName.name(), carrierServiceName);
100                }
101            } else {
102                addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName);
103            }
104            
105        } else {
106            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
107        }
108        
109        return result;
110    }
111    
112}