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