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.CreateWorkflowStepForm;
020import com.echothree.control.user.workflow.common.result.WorkflowResultFactory;
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.control.workflow.server.control.WorkflowControl;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.model.data.workflow.server.entity.WorkflowStep;
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.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038
039@Dependent
040public class CreateWorkflowStepCommand
041        extends BaseSimpleCommand<CreateWorkflowStepForm> {
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(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                    new SecurityRoleDefinition(SecurityRoleGroups.WorkflowStep.name(), SecurityRoles.Create.name())
051                    ))
052                ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("WorkflowStepName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("WorkflowStepTypeName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
059                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
060                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
061                );
062    }
063    
064    /** Creates a new instance of CreateWorkflowStepCommand */
065    public CreateWorkflowStepCommand() {
066        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        var result = WorkflowResultFactory.getCreateWorkflowStepResult();
072        var workflowControl = Session.getModelController(WorkflowControl.class);
073        var workflowName = form.getWorkflowName();
074        var workflow = workflowControl.getWorkflowByName(workflowName);
075        WorkflowStep workflowStep = null;
076        
077        if(workflow != null) {
078            var workflowStepName = form.getWorkflowStepName();
079
080            workflowStep = workflowControl.getWorkflowStepByName(workflow, workflowStepName);
081            
082            if(workflowStep == null) {
083                var workflowStepTypeName = form.getWorkflowStepTypeName();
084                var workflowStepType = workflowControl.getWorkflowStepTypeByName(workflowStepTypeName);
085                
086                if(workflowStepType != null) {
087                    var partyPK = getPartyPK();
088                    var isDefault = Boolean.valueOf(form.getIsDefault());
089                    var sortOrder = Integer.valueOf(form.getSortOrder());
090                    var description = form.getDescription();
091                    
092                    workflowStep = workflowControl.createWorkflowStep(workflow, workflowStepName, workflowStepType, isDefault,
093                            sortOrder, partyPK);
094                    
095                    if(description != null) {
096                        workflowControl.createWorkflowStepDescription(workflowStep, getPreferredLanguage(), description, partyPK);
097                    }
098                } else {
099                    addExecutionError(ExecutionErrors.UnknownWorkflowStepTypeName.name(), workflowStepTypeName);
100                }
101            } else {
102                addExecutionError(ExecutionErrors.DuplicateWorkflowStepName.name(), workflowStepName);
103            }
104        } else {
105            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
106        }
107
108        if(workflowStep != null) {
109            var basePK = workflowStep.getPrimaryKey();
110            var workflowStepDetail = workflowStep.getLastDetail();
111
112            result.setWorkflowName(workflowStepDetail.getWorkflow().getLastDetail().getWorkflowName());
113            result.setWorkflowStepName(workflowStepDetail.getWorkflowStepName());
114            result.setEntityRef(basePK.getEntityRef());
115        }
116
117        return result;
118    }
119    
120}