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