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.DeleteWorkflowDestinationDescriptionForm;
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.party.server.entity.Language;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.model.data.workflow.server.entity.Workflow;
028import com.echothree.model.data.workflow.server.entity.WorkflowDestination;
029import com.echothree.model.data.workflow.server.entity.WorkflowDestinationDescription;
030import com.echothree.model.data.workflow.server.entity.WorkflowStep;
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 DeleteWorkflowDestinationDescriptionCommand
045        extends BaseSimpleCommand<DeleteWorkflowDestinationDescriptionForm> {
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.WorkflowDestination.name(), SecurityRoles.Description.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("WorkflowStepName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("WorkflowDestinationName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
063                ));
064    }
065    
066    /** Creates a new instance of DeleteWorkflowDestinationDescriptionCommand */
067    public DeleteWorkflowDestinationDescriptionCommand(UserVisitPK userVisitPK, DeleteWorkflowDestinationDescriptionForm form) {
068        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
069    }
070    
071    @Override
072    protected BaseResult execute() {
073        var workflowControl = Session.getModelController(WorkflowControl.class);
074        String workflowName = form.getWorkflowName();
075        var workflow = workflowControl.getWorkflowByName(workflowName);
076        
077        if(workflow != null) {
078            String workflowStepName = form.getWorkflowStepName();
079            var workflowStep = workflowControl.getWorkflowStepByName(workflow, workflowStepName);
080            
081            if(workflowStep != null) {
082                String workflowDestinationName = form.getWorkflowDestinationName();
083                WorkflowDestination workflowDestination = workflowControl.getWorkflowDestinationByName(workflowStep, workflowDestinationName);
084                
085                if(workflowDestination != null) {
086                    var partyControl = Session.getModelController(PartyControl.class);
087                    String languageIsoName = form.getLanguageIsoName();
088                    Language language = partyControl.getLanguageByIsoName(languageIsoName);
089                    
090                    if(language != null) {
091                        WorkflowDestinationDescription workflowStepDescription = workflowControl.getWorkflowDestinationDescriptionForUpdate(workflowDestination, language);
092                        
093                        if(workflowStepDescription != null) {
094                            workflowControl.deleteWorkflowDestinationDescription(workflowStepDescription, getPartyPK());
095                        } else {
096                            addExecutionError(ExecutionErrors.UnknownWorkflowDestinationDescription.name());
097                        }
098                    } else {
099                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
100                    }
101                } else {
102                    addExecutionError(ExecutionErrors.UnknownWorkflowDestinationName.name(), workflowDestinationName);
103                }
104            } else {
105                addExecutionError(ExecutionErrors.UnknownWorkflowStepName.name(), workflowStepName);
106            }
107        } else {
108            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
109        }
110        
111        return null;
112    }
113    
114}