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.CreateShippingMethodDescriptionForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.party.server.control.PartyControl;
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.user.common.pk.UserVisitPK;
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 java.util.List;
035import javax.enterprise.context.Dependent;
036import javax.inject.Inject;
037
038@Dependent
039public class CreateShippingMethodDescriptionCommand
040        extends BaseSimpleCommand<CreateShippingMethodDescriptionForm> {
041    
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.ShippingMethod.name(), SecurityRoles.Description.name())
050                ))
051        ));
052
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("ShippingMethodName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
057        );
058    }
059
060    @Inject
061    PartyControl partyControl;
062
063    @Inject
064    ShippingControl shippingControl;
065
066    
067    /** Creates a new instance of CreateShippingMethodDescriptionCommand */
068    public CreateShippingMethodDescriptionCommand() {
069        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
070    }
071    
072    @Override
073    protected BaseResult execute() {
074        var shippingMethodName = form.getShippingMethodName();
075        var shippingMethod = shippingControl.getShippingMethodByName(shippingMethodName);
076            
077            if(shippingMethod != null) {
078                var languageIsoName = form.getLanguageIsoName();
079                var language = partyControl.getLanguageByIsoName(languageIsoName);
080                
081                if(language != null) {
082                    var shippingMethodDescription = shippingControl.getShippingMethodDescription(shippingMethod, language);
083                    
084                    if(shippingMethodDescription == null) {
085                        var description = form.getDescription();
086                        
087                        shippingControl.createShippingMethodDescription(shippingMethod, language, description, getPartyPK());
088                    } else {
089                        addExecutionError(ExecutionErrors.DuplicateShippingMethodDescription.name(), shippingMethodName, languageIsoName);
090                    }
091                } else {
092                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
093                }
094            } else {
095                addExecutionError(ExecutionErrors.UnknownShippingMethodName.name(), shippingMethodName);
096            }
097        
098        return null;
099    }
100    
101}