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.workflow.server.command;
018
019import com.echothree.control.user.workflow.common.form.CreateWorkflowEntranceDescriptionForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.party.server.control.PartyControl;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.control.workflow.server.control.WorkflowControl;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
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.common.command.BaseResult;
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 CreateWorkflowEntranceDescriptionCommand
040        extends BaseSimpleCommand<CreateWorkflowEntranceDescriptionForm> {
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.WorkflowEntrance.name(), SecurityRoles.Description.name())
050                ))
051        ));
052
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("WorkflowEntranceName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
058        );
059    }
060
061    @Inject
062    PartyControl partyControl;
063
064    @Inject
065    WorkflowControl workflowControl;
066
067    
068    /** Creates a new instance of CreateWorkflowEntranceDescriptionCommand */
069    public CreateWorkflowEntranceDescriptionCommand() {
070        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
071    }
072    
073    @Override
074    protected BaseResult execute() {
075        var workflowName = form.getWorkflowName();
076        var workflow = workflowControl.getWorkflowByName(workflowName);
077        
078        if(workflow != null) {
079            var workflowEntranceName = form.getWorkflowEntranceName();
080            var workflowEntrance = workflowControl.getWorkflowEntranceByName(workflow, workflowEntranceName);
081            
082            if(workflowEntrance != null) {
083                var languageIsoName = form.getLanguageIsoName();
084                var language = partyControl.getLanguageByIsoName(languageIsoName);
085                
086                if(language != null) {
087                    var workflowStepDescription = workflowControl.getWorkflowEntranceDescription(workflowEntrance, language);
088                    
089                    if(workflowStepDescription == null) {
090                        var description = form.getDescription();
091                        
092                        workflowControl.createWorkflowEntranceDescription(workflowEntrance, language, description, getPartyPK());
093                    } else {
094                        addExecutionError(ExecutionErrors.DuplicateWorkflowEntranceDescription.name());
095                    }
096                } else {
097                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
098                }
099            } else {
100                addExecutionError(ExecutionErrors.UnknownWorkflowEntranceName.name(), workflowEntranceName);
101            }
102        } else {
103            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
104        }
105        
106        return null;
107    }
108    
109}