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
019
020import com.echothree.control.user.core.common.form.CreateCommandMessageForm;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.data.core.server.entity.CommandMessage;
025import com.echothree.model.data.core.server.entity.CommandMessageType;
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 java.util.Arrays;
036import java.util.Collections;
037import java.util.List;
038
039public class CreateCommandMessageCommand
040        extends BaseSimpleCommand<CreateCommandMessageForm> {
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(Collections.unmodifiableList(Arrays.asList(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
049                        new SecurityRoleDefinition(SecurityRoleGroups.CommandMessage.name(), SecurityRoles.Create.name())
050                        )))
051                )));
052        
053        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
054                new FieldDefinition("CommandMessageTypeName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("CommandMessageKey", FieldType.KEY, true, null, null),
056                new FieldDefinition("Translation", FieldType.STRING, false, 1L, 512L)
057                ));
058    }
059    
060    /** Creates a new instance of CreateCommandMessageCommand */
061    public CreateCommandMessageCommand(UserVisitPK userVisitPK, CreateCommandMessageForm form) {
062        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
063    }
064    
065    @Override
066    protected BaseResult execute() {
067        var coreControl = getCoreControl();
068        String commandMessageTypeName = form.getCommandMessageTypeName();
069        CommandMessageType commandMessageType = coreControl.getCommandMessageTypeByName(commandMessageTypeName);
070        
071        if(commandMessageType != null) {
072            String commandMessageKey = form.getCommandMessageKey();
073            CommandMessage commandMessage = coreControl.getCommandMessageByKey(commandMessageType, commandMessageKey);
074            
075            if(commandMessage == null) {
076                var partyPK = getPartyPK();
077                String translation = form.getTranslation();
078
079                commandMessage = coreControl.createCommandMessage(commandMessageType, commandMessageKey, partyPK);
080
081                if(translation != null) {
082                    coreControl.createCommandMessageTranslation(commandMessage, getPreferredLanguage(), translation, partyPK);
083                }
084            } else {
085                addExecutionError(ExecutionErrors.DuplicateCommandMessageKey.name(), commandMessageTypeName, commandMessageKey);
086            }
087        } else {
088            addExecutionError(ExecutionErrors.UnknownCommandMessageTypeName.name(), commandMessageTypeName);
089        }
090        
091        return null;
092    }
093    
094}