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.core.server.control.CommandControl;
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.user.common.pk.UserVisitPK;
025import com.echothree.util.common.command.BaseResult;
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.server.control.BaseSimpleCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import com.echothree.util.server.persistence.Session;
034import java.util.List;
035import javax.enterprise.context.Dependent;
036
037@Dependent
038public class CreateCommandMessageCommand
039        extends BaseSimpleCommand<CreateCommandMessageForm> {
040    
041    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
042    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
043    
044    static {
045        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
046                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
048                        new SecurityRoleDefinition(SecurityRoleGroups.CommandMessage.name(), SecurityRoles.Create.name())
049                        ))
050                ));
051        
052        FORM_FIELD_DEFINITIONS = List.of(
053                new FieldDefinition("CommandMessageTypeName", FieldType.ENTITY_NAME, true, null, null),
054                new FieldDefinition("CommandMessageKey", FieldType.KEY, true, null, null),
055                new FieldDefinition("Translation", FieldType.STRING, false, 1L, 512L)
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 commandControl = Session.getModelController(CommandControl.class);
067        var commandMessageTypeName = form.getCommandMessageTypeName();
068        var commandMessageType = commandControl.getCommandMessageTypeByName(commandMessageTypeName);
069        
070        if(commandMessageType != null) {
071            var commandMessageKey = form.getCommandMessageKey();
072            var commandMessage = commandControl.getCommandMessageByKey(commandMessageType, commandMessageKey);
073            
074            if(commandMessage == null) {
075                var partyPK = getPartyPK();
076                var translation = form.getTranslation();
077
078                commandMessage = commandControl.createCommandMessage(commandMessageType, commandMessageKey, partyPK);
079
080                if(translation != null) {
081                    commandControl.createCommandMessageTranslation(commandMessage, getPreferredLanguage(), translation, partyPK);
082                }
083            } else {
084                addExecutionError(ExecutionErrors.DuplicateCommandMessageKey.name(), commandMessageTypeName, commandMessageKey);
085            }
086        } else {
087            addExecutionError(ExecutionErrors.UnknownCommandMessageTypeName.name(), commandMessageTypeName);
088        }
089        
090        return null;
091    }
092    
093}