001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.core.server.command;
018
019import com.echothree.control.user.core.common.form.CreateCommandDescriptionForm;
020import com.echothree.model.control.party.server.control.PartyControl;
021import com.echothree.model.data.core.server.entity.Command;
022import com.echothree.model.data.core.server.entity.CommandDescription;
023import com.echothree.model.data.core.server.entity.ComponentVendor;
024import com.echothree.model.data.party.server.entity.Language;
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.persistence.Session;
032import java.util.Arrays;
033import java.util.Collections;
034import java.util.List;
035
036public class CreateCommandDescriptionCommand
037        extends BaseSimpleCommand<CreateCommandDescriptionForm> {
038    
039    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
040    
041    static {
042        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
043            new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
044            new FieldDefinition("CommandName", FieldType.COMMAND_NAME, true, null, null),
045            new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null),
046            new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
047        ));
048    }
049    
050    /** Creates a new instance of CreateCommandDescriptionCommand */
051    public CreateCommandDescriptionCommand(UserVisitPK userVisitPK, CreateCommandDescriptionForm form) {
052        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, false);
053    }
054    
055    @Override
056    protected BaseResult execute() {
057        var coreControl = getCoreControl();
058        String componentVendorName = form.getComponentVendorName();
059        ComponentVendor componentVendor = coreControl.getComponentVendorByName(componentVendorName);
060        
061        if(componentVendor != null) {
062            String commandName = form.getCommandName();
063            Command command = coreControl.getCommandByName(componentVendor, commandName);
064            
065            if(command != null) {
066                var partyControl = Session.getModelController(PartyControl.class);
067                String languageIsoName = form.getLanguageIsoName();
068                Language language = partyControl.getLanguageByIsoName(languageIsoName);
069                
070                if(language != null) {
071                    CommandDescription commandDescription = coreControl.getCommandDescription(command, language);
072                    
073                    if(commandDescription == null) {
074                        var description = form.getDescription();
075                        
076                        coreControl.createCommandDescription(command, language, description, getPartyPK());
077                    } else {
078                        addExecutionError(ExecutionErrors.DuplicateCommandDescription.name());
079                    }
080                } else {
081                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
082                }
083            } else {
084                addExecutionError(ExecutionErrors.UnknownCommandName.name(), commandName);
085            }
086        } else {
087            addExecutionError(ExecutionErrors.UnknownComponentVendorName.name(), componentVendorName);
088        }
089        
090        return null;
091    }
092    
093}