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.SetDefaultWorkflowDestinationForm;
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.WorkflowStep;
027import com.echothree.model.data.workflow.server.value.WorkflowDestinationDetailValue;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.server.control.BaseSimpleCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import com.echothree.util.server.persistence.Session;
037import java.util.Arrays;
038import java.util.Collections;
039import java.util.List;
040
041public class SetDefaultWorkflowDestinationCommand
042        extends BaseSimpleCommand<SetDefaultWorkflowDestinationForm> {
043    
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
050                    new SecurityRoleDefinition(SecurityRoleGroups.WorkflowDestination.name(), SecurityRoles.Edit.name())
051                    )))
052                )));
053        
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("WorkflowStepName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("WorkflowDestinationName", FieldType.ENTITY_NAME, true, null, null)
058                ));
059    }
060    
061    /** Creates a new instance of SetDefaultWorkflowDestinationCommand */
062    public SetDefaultWorkflowDestinationCommand(UserVisitPK userVisitPK, SetDefaultWorkflowDestinationForm form) {
063        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var workflowControl = Session.getModelController(WorkflowControl.class);
069        String workflowName = form.getWorkflowName();
070        var workflow = workflowControl.getWorkflowByName(workflowName);
071        
072        if(workflow != null) {
073            String workflowStepName = form.getWorkflowStepName();
074            var workflowStep = workflowControl.getWorkflowStepByName(workflow, workflowStepName);
075            
076            if(workflowStep != null) {
077                String workflowDestinationName = form.getWorkflowDestinationName();
078                WorkflowDestinationDetailValue workflowDestinationDetailValue = workflowControl.getWorkflowDestinationDetailValueByNameForUpdate(workflowStep, workflowDestinationName);
079                
080                if(workflowDestinationDetailValue != null) {
081                    workflowDestinationDetailValue.setIsDefault(Boolean.TRUE);
082                    workflowControl.updateWorkflowDestinationFromValue(workflowDestinationDetailValue, getUserVisitPK());
083                } else {
084                    addExecutionError(ExecutionErrors.UnknownWorkflowDestinationName.name(), workflowName, workflowStepName, workflowDestinationName);
085                }
086            } else {
087                addExecutionError(ExecutionErrors.UnknownWorkflowStepName.name(), workflowName, workflowStepName);
088            }
089        } else {
090            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
091        }
092        
093        return null;
094    }
095    
096}