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.GetShippingMethodCarrierServiceForm;
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.control.shipping.server.logic.ShippingMethodLogic;
027import com.echothree.model.data.shipping.server.entity.ShippingMethodCarrierService;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BaseSingleEntityCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038import javax.inject.Inject;
039
040@Dependent
041public class GetShippingMethodCarrierServiceCommand
042        extends BaseSingleEntityCommand<ShippingMethodCarrierService, GetShippingMethodCarrierServiceForm> {
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(List.of(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
051                        new SecurityRoleDefinition(SecurityRoleGroups.ShippingMethodCarrierService.name(), SecurityRoles.Review.name())
052                ))
053        ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("ShippingMethodName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("CarrierName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("CarrierServiceName", FieldType.ENTITY_NAME, true, null, null)
059        );
060    }
061
062    @Inject
063    CarrierControl carrierControl;
064
065    @Inject
066    ShippingControl shippingControl;
067
068    @Inject
069    ShippingMethodLogic shippingMethodLogic;
070
071    /** Creates a new instance of GetShippingMethodCarrierServiceCommand */
072    public GetShippingMethodCarrierServiceCommand() {
073        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
074    }
075
076    @Override
077    protected ShippingMethodCarrierService getEntity() {
078        ShippingMethodCarrierService shippingMethodCarrierService = null;
079        var shippingMethodName = form.getShippingMethodName();
080        var shippingMethod = shippingMethodLogic.getShippingMethodByName(this, shippingMethodName);
081
082        if(!hasExecutionErrors()) {
083            var carrierName = form.getCarrierName();
084            var carrier = carrierControl.getCarrierByName(carrierName);
085
086            if(carrier != null) {
087                var carrierParty = carrier.getParty();
088                var carrierServiceName = form.getCarrierServiceName();
089                var carrierService = carrierControl.getCarrierServiceByName(carrierParty, carrierServiceName);
090
091                if(carrierService != null) {
092                    shippingMethodCarrierService = shippingControl.getShippingMethodCarrierService(shippingMethod, carrierService);
093
094                    if(shippingMethodCarrierService == null) {
095                        addExecutionError(ExecutionErrors.UnknownShippingMethodCarrierService.name(), shippingMethodName, carrierName, carrierServiceName);
096                    }
097                } else {
098                    addExecutionError(ExecutionErrors.UnknownCarrierServiceName.name(), carrierName, carrierServiceName);
099                }
100            } else {
101                addExecutionError(ExecutionErrors.UnknownCarrierName.name(), carrierName);
102            }
103        }
104
105        return shippingMethodCarrierService;
106    }
107
108    @Override
109    protected BaseResult getResult(ShippingMethodCarrierService shippingMethodCarrierService) {
110        var result = ShippingResultFactory.getGetShippingMethodCarrierServiceResult();
111
112        if(shippingMethodCarrierService != null) {
113            result.setShippingMethodCarrierService(shippingControl.getShippingMethodCarrierServiceTransfer(getUserVisit(), shippingMethodCarrierService));
114        }
115
116        return result;
117    }
118
119}