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.CreateWorkflowDestinationDescriptionForm;
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 CreateWorkflowDestinationDescriptionCommand
040        extends BaseSimpleCommand<CreateWorkflowDestinationDescriptionForm> {
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.WorkflowDestination.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("WorkflowStepName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("WorkflowDestinationName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
059        );
060    }
061
062    @Inject
063    PartyControl partyControl;
064
065    @Inject
066    WorkflowControl workflowControl;
067
068    
069    /** Creates a new instance of CreateWorkflowDestinationDescriptionCommand */
070    public CreateWorkflowDestinationDescriptionCommand() {
071        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
072    }
073    
074    @Override
075    protected BaseResult execute() {
076        var workflowName = form.getWorkflowName();
077        var workflow = workflowControl.getWorkflowByName(workflowName);
078        
079        if(workflow != null) {
080            var workflowStepName = form.getWorkflowStepName();
081            var workflowStep = workflowControl.getWorkflowStepByName(workflow, workflowStepName);
082            
083            if(workflowStep != null) {
084                var workflowDestinationName = form.getWorkflowDestinationName();
085                var workflowDestination = workflowControl.getWorkflowDestinationByName(workflowStep, workflowDestinationName);
086                
087                if(workflowDestination != null) {
088                    var languageIsoName = form.getLanguageIsoName();
089                    var language = partyControl.getLanguageByIsoName(languageIsoName);
090                    
091                    if(language != null) {
092                        var workflowStepDescription = workflowControl.getWorkflowDestinationDescription(workflowDestination, language);
093                        
094                        if(workflowStepDescription == null) {
095                            var description = form.getDescription();
096                            
097                            workflowControl.createWorkflowDestinationDescription(workflowDestination, language, description, getPartyPK());
098                        } else {
099                            addExecutionError(ExecutionErrors.DuplicateWorkflowDestinationDescription.name());
100                        }
101                    } else {
102                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
103                    }
104                } else {
105                    addExecutionError(ExecutionErrors.UnknownWorkflowDestinationName.name(), workflowDestinationName);
106                }
107            } else {
108                addExecutionError(ExecutionErrors.UnknownWorkflowStepName.name(), workflowStepName);
109            }
110        } else {
111            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
112        }
113        
114        return null;
115    }
116    
117}