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.core.server.command;
018
019import com.echothree.control.user.core.common.form.CreateCommandMessageForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.security.common.SecurityRoleGroups;
022import com.echothree.model.control.security.common.SecurityRoles;
023import com.echothree.model.data.user.common.pk.UserVisitPK;
024import com.echothree.util.common.command.BaseResult;
025import com.echothree.util.common.message.ExecutionErrors;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.server.control.BaseSimpleCommand;
029import com.echothree.util.server.control.CommandSecurityDefinition;
030import com.echothree.util.server.control.PartyTypeDefinition;
031import com.echothree.util.server.control.SecurityRoleDefinition;
032import java.util.List;
033import javax.enterprise.context.Dependent;
034import javax.inject.Inject;
035
036@Dependent
037public class CreateCommandMessageCommand
038        extends BaseSimpleCommand<CreateCommandMessageForm> {
039    
040    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
041    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
042    
043    static {
044        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
045                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
046                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
047                        new SecurityRoleDefinition(SecurityRoleGroups.CommandMessage.name(), SecurityRoles.Create.name())
048                ))
049        ));
050        
051        FORM_FIELD_DEFINITIONS = List.of(
052                new FieldDefinition("CommandMessageTypeName", FieldType.ENTITY_NAME, true, null, null),
053                new FieldDefinition("CommandMessageKey", FieldType.KEY, true, null, null),
054                new FieldDefinition("Translation", FieldType.STRING, false, 1L, 512L)
055        );
056    }
057
058    
059    /** Creates a new instance of CreateCommandMessageCommand */
060    public CreateCommandMessageCommand() {
061        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
062    }
063    
064    @Override
065    protected BaseResult execute() {
066        var commandMessageTypeName = form.getCommandMessageTypeName();
067        var commandMessageType = commandControl.getCommandMessageTypeByName(commandMessageTypeName);
068        
069        if(commandMessageType != null) {
070            var commandMessageKey = form.getCommandMessageKey();
071            var commandMessage = commandControl.getCommandMessageByKey(commandMessageType, commandMessageKey);
072            
073            if(commandMessage == null) {
074                var partyPK = getPartyPK();
075                var translation = form.getTranslation();
076
077                commandMessage = commandControl.createCommandMessage(commandMessageType, commandMessageKey, partyPK);
078
079                if(translation != null) {
080                    commandControl.createCommandMessageTranslation(commandMessage, getPreferredLanguage(), translation, partyPK);
081                }
082            } else {
083                addExecutionError(ExecutionErrors.DuplicateCommandMessageKey.name(), commandMessageTypeName, commandMessageKey);
084            }
085        } else {
086            addExecutionError(ExecutionErrors.UnknownCommandMessageTypeName.name(), commandMessageTypeName);
087        }
088        
089        return null;
090    }
091    
092}