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