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.control.user.core.common.result.CoreResultFactory;
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.user.common.pk.UserVisitPK;
026import com.echothree.util.common.command.BaseResult;
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.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import java.util.List;
035import javax.enterprise.context.Dependent;
036import javax.inject.Inject;
037
038@Dependent
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(List.of(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.CommandMessage.name(), SecurityRoles.Create.name())
050                ))
051        ));
052        
053        FORM_FIELD_DEFINITIONS = List.of(
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    
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 result = CoreResultFactory.getCreateCommandMessageResult();
069        CommandMessage commandMessage = null;
070        var commandMessageTypeName = form.getCommandMessageTypeName();
071        var commandMessageType = commandControl.getCommandMessageTypeByName(commandMessageTypeName);
072        
073        if(commandMessageType != null) {
074            var commandMessageKey = form.getCommandMessageKey();
075
076            commandMessage = commandControl.getCommandMessageByKey(commandMessageType, commandMessageKey);
077            
078            if(commandMessage == null) {
079                var partyPK = getPartyPK();
080                var translation = form.getTranslation();
081
082                commandMessage = commandControl.createCommandMessage(commandMessageType, commandMessageKey, partyPK);
083
084                if(translation != null) {
085                    commandControl.createCommandMessageTranslation(commandMessage, getPreferredLanguage(), translation, partyPK);
086                }
087            } else {
088                addExecutionError(ExecutionErrors.DuplicateCommandMessageKey.name(), commandMessageTypeName, commandMessageKey);
089            }
090        } else {
091            addExecutionError(ExecutionErrors.UnknownCommandMessageTypeName.name(), commandMessageTypeName);
092        }
093        
094        if(commandMessage != null) {
095            result.setEntityRef(commandMessage.getPrimaryKey().getEntityRef());
096            result.setCommandMessageTypeName(commandMessage.getLastDetail().getCommandMessageType().getLastDetail().getCommandMessageTypeName());
097            result.setCommandMessageKey(commandMessage.getLastDetail().getCommandMessageKey());
098        }
099
100        return result;
101    }
102    
103}