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.CreateWorkflowEntranceStepForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.security.common.SecurityRoleGroups;
022import com.echothree.model.control.security.common.SecurityRoles;
023import com.echothree.model.control.workflow.server.control.WorkflowControl;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.model.data.workflow.server.entity.Workflow;
026import com.echothree.model.data.workflow.server.entity.WorkflowEntrance;
027import com.echothree.model.data.workflow.server.entity.WorkflowEntranceStep;
028import com.echothree.model.data.workflow.server.entity.WorkflowStep;
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 CreateWorkflowEntranceStepCommand
043        extends BaseSimpleCommand<CreateWorkflowEntranceStepForm> {
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.WorkflowEntrance.name(), SecurityRoles.WorkflowStep.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("WorkflowEntranceName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("EntranceWorkflowName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("EntranceWorkflowStepName", FieldType.ENTITY_NAME, true, null, null)
061                ));
062    }
063    
064    /** Creates a new instance of CreateWorkflowEntranceStepCommand */
065    public CreateWorkflowEntranceStepCommand(UserVisitPK userVisitPK, CreateWorkflowEntranceStepForm form) {
066        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        var workflowControl = Session.getModelController(WorkflowControl.class);
072        String workflowName = form.getWorkflowName();
073        var workflow = workflowControl.getWorkflowByName(workflowName);
074        
075        if(workflow != null) {
076            String workflowEntranceName = form.getWorkflowEntranceName();
077            WorkflowEntrance workflowEntrance = workflowControl.getWorkflowEntranceByName(workflow, workflowEntranceName);
078            
079            if(workflowEntrance != null) {
080                String entranceWorkflowName = form.getEntranceWorkflowName();
081                Workflow entranceWorkflow = workflowControl.getWorkflowByName(entranceWorkflowName);
082                
083                if(entranceWorkflow != null) {
084                    String entranceWorkflowStepName = form.getEntranceWorkflowStepName();
085                    WorkflowStep entranceWorkflowStep = workflowControl.getWorkflowStepByName(entranceWorkflow, entranceWorkflowStepName);
086                    
087                    if(entranceWorkflowStep != null) {
088                        WorkflowEntranceStep workflowEntranceStep = workflowControl.getWorkflowEntranceStep(workflowEntrance, entranceWorkflowStep);
089                        
090                        if(workflowEntranceStep == null) {
091                            workflowControl.createWorkflowEntranceStep(workflowEntrance, entranceWorkflowStep, getPartyPK());
092                        } else {
093                            addExecutionError(ExecutionErrors.DuplicateWorkflowEntranceStep.name(), workflowName, workflowEntranceName, entranceWorkflowName,
094                                    entranceWorkflowStepName);
095                        }
096                    } else {
097                        addExecutionError(ExecutionErrors.UnknownEntranceWorkflowStepName.name(), entranceWorkflowName, entranceWorkflowStepName);
098                    }
099                } else {
100                    addExecutionError(ExecutionErrors.UnknownEntranceWorkflowName.name(), entranceWorkflowName);
101                }
102            } else {
103                addExecutionError(ExecutionErrors.UnknownWorkflowEntranceName.name(), workflowName, workflowEntranceName);
104            }
105        } else {
106            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
107        }
108        
109        return null;
110    }
111    
112}