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.DeleteWorkflowEntranceSelectorForm;
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.selector.server.control.SelectorControl;
024import com.echothree.model.control.workflow.server.control.WorkflowControl;
025import com.echothree.model.data.selector.server.entity.Selector;
026import com.echothree.model.data.selector.server.entity.SelectorType;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.model.data.workflow.server.entity.Workflow;
029import com.echothree.model.data.workflow.server.entity.WorkflowEntrance;
030import com.echothree.model.data.workflow.server.entity.WorkflowEntranceSelector;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.BaseResult;
035import com.echothree.util.server.control.BaseSimpleCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.Arrays;
041import java.util.Collections;
042import java.util.List;
043
044public class DeleteWorkflowEntranceSelectorCommand
045        extends BaseSimpleCommand<DeleteWorkflowEntranceSelectorForm> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
049    
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
054                    new SecurityRoleDefinition(SecurityRoleGroups.WorkflowEntrance.name(), SecurityRoles.Selector.name())
055                    )))
056                )));
057
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("WorkflowEntranceName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("SelectorName", FieldType.ENTITY_NAME, true, null, null)
062                ));
063    }
064    
065    /** Creates a new instance of DeleteWorkflowEntranceSelectorCommand */
066    public DeleteWorkflowEntranceSelectorCommand(UserVisitPK userVisitPK, DeleteWorkflowEntranceSelectorForm form) {
067        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
068    }
069    
070    @Override
071    protected BaseResult execute() {
072        var workflowControl = Session.getModelController(WorkflowControl.class);
073        String workflowName = form.getWorkflowName();
074        var workflow = workflowControl.getWorkflowByName(workflowName);
075        
076        if(workflow != null) {
077            SelectorType selectorType = workflow.getLastDetail().getSelectorType();
078            
079            if(selectorType != null) {
080                String workflowEntranceName = form.getWorkflowEntranceName();
081                WorkflowEntrance workflowEntrance = workflowControl.getWorkflowEntranceByName(workflow, workflowEntranceName);
082                
083                if(workflowEntrance != null) {
084                    var selectorControl = Session.getModelController(SelectorControl.class);
085                    String selectorName = form.getSelectorName();
086                    Selector selector = selectorControl.getSelectorByName(selectorType, selectorName);
087                    
088                    if(selector != null) {
089                        WorkflowEntranceSelector workflowEntranceSelector = workflowControl.getWorkflowEntranceSelectorForUpdate(workflowEntrance, selector);
090                        
091                        if(workflowEntranceSelector != null) {
092                            workflowControl.deleteWorkflowEntranceSelector(workflowEntranceSelector, getPartyPK());
093                        } else {
094                            addExecutionError(ExecutionErrors.UnknownWorkflowEntranceSelector.name());
095                        }
096                    } else {
097                        addExecutionError(ExecutionErrors.UnknownSelectorName.name(), selectorName);
098                    }
099                } else {
100                    addExecutionError(ExecutionErrors.UnknownWorkflowEntranceName.name(), workflowEntranceName);
101                }
102            } else {
103                addExecutionError(ExecutionErrors.InvalidWorkflow.name());
104            }
105        } else {
106            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
107        }
108        
109        return null;
110    }
111    
112}