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.CreateCommandForm;
020import com.echothree.model.data.core.server.entity.Command;
021import com.echothree.model.data.core.server.entity.ComponentVendor;
022import com.echothree.model.data.user.common.pk.UserVisitPK;
023import com.echothree.util.common.message.ExecutionErrors;
024import com.echothree.util.common.validation.FieldDefinition;
025import com.echothree.util.common.validation.FieldType;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.server.control.BaseSimpleCommand;
028import java.util.Arrays;
029import java.util.Collections;
030import java.util.List;
031
032public class CreateCommandCommand
033        extends BaseSimpleCommand<CreateCommandForm> {
034    
035    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
036    
037    static {
038        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
039            new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
040            new FieldDefinition("CommandName", FieldType.COMMAND_NAME, true, null, null),
041            new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
042            new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
043        ));
044    }
045    
046    /** Creates a new instance of CreateCommandCommand */
047    public CreateCommandCommand(UserVisitPK userVisitPK, CreateCommandForm form) {
048        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, false);
049    }
050    
051    @Override
052    protected BaseResult execute() {
053        var coreControl = getCoreControl();
054        String componentVendorName = form.getComponentVendorName();
055        ComponentVendor componentVendor = coreControl.getComponentVendorByName(componentVendorName);
056        
057        if(componentVendor != null) {
058            String commandName = form.getCommandName();
059            Command command = coreControl.getCommandByName(componentVendor, commandName);
060            
061            if(command == null) {
062                var partyPK = getPartyPK();
063                var sortOrder = Integer.valueOf(form.getSortOrder());
064                var description = form.getDescription();
065                
066                command = coreControl.createCommand(componentVendor, commandName, sortOrder, partyPK);
067                
068                if(description != null) {
069                    coreControl.createCommandDescription(command, getPreferredLanguage(), description, partyPK);
070                }
071            } else {
072                addExecutionError(ExecutionErrors.DuplicateCommandName.name(), commandName);
073            }
074        } else {
075            addExecutionError(ExecutionErrors.UnknownComponentVendorName.name(), componentVendorName);
076        }
077        
078        return null;
079    }
080    
081}