001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.Arrays;
035import java.util.Collections;
036import java.util.List;
037import javax.enterprise.context.RequestScoped;
038
039@RequestScoped
040public class CreateCommandMessageCommand
041        extends BaseSimpleCommand<CreateCommandMessageForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
050                        new SecurityRoleDefinition(SecurityRoleGroups.CommandMessage.name(), SecurityRoles.Create.name())
051                        )))
052                )));
053        
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055                new FieldDefinition("CommandMessageTypeName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("CommandMessageKey", FieldType.KEY, true, null, null),
057                new FieldDefinition("Translation", FieldType.STRING, false, 1L, 512L)
058                ));
059    }
060    
061    /** Creates a new instance of CreateCommandMessageCommand */
062    public CreateCommandMessageCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var commandControl = Session.getModelController(CommandControl.class);
069        var commandMessageTypeName = form.getCommandMessageTypeName();
070        var commandMessageType = commandControl.getCommandMessageTypeByName(commandMessageTypeName);
071        
072        if(commandMessageType != null) {
073            var commandMessageKey = form.getCommandMessageKey();
074            var commandMessage = commandControl.getCommandMessageByKey(commandMessageType, commandMessageKey);
075            
076            if(commandMessage == null) {
077                var partyPK = getPartyPK();
078                var translation = form.getTranslation();
079
080                commandMessage = commandControl.createCommandMessage(commandMessageType, commandMessageKey, partyPK);
081
082                if(translation != null) {
083                    commandControl.createCommandMessageTranslation(commandMessage, getPreferredLanguage(), translation, partyPK);
084                }
085            } else {
086                addExecutionError(ExecutionErrors.DuplicateCommandMessageKey.name(), commandMessageTypeName, commandMessageKey);
087            }
088        } else {
089            addExecutionError(ExecutionErrors.UnknownCommandMessageTypeName.name(), commandMessageTypeName);
090        }
091        
092        return null;
093    }
094    
095}