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.CreateWorkflowDestinationForm;
020import com.echothree.control.user.workflow.common.result.WorkflowResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
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.user.common.pk.UserVisitPK;
026import com.echothree.model.data.workflow.server.entity.WorkflowDestination;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class CreateWorkflowDestinationCommand
041        extends BaseSimpleCommand<CreateWorkflowDestinationForm> {
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(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.WorkflowDestination.name(), SecurityRoles.Create.name())
051                ))
052        ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
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                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
059                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
060                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
061        );
062    }
063
064    @Inject
065    WorkflowControl workflowControl;
066
067    
068    /** Creates a new instance of CreateWorkflowDestinationCommand */
069    public CreateWorkflowDestinationCommand() {
070        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
071    }
072    
073    @Override
074    protected BaseResult execute() {
075        var result = WorkflowResultFactory.getCreateWorkflowDestinationResult();
076        var workflowName = form.getWorkflowName();
077        var workflow = workflowControl.getWorkflowByName(workflowName);
078        WorkflowDestination workflowDestination = null;
079        
080        if(workflow != null) {
081            var workflowStepName = form.getWorkflowStepName();
082            var workflowStep = workflowControl.getWorkflowStepByName(workflow, workflowStepName);
083            
084            if(workflowStep != null) {
085                var workflowDestinationName = form.getWorkflowDestinationName();
086                
087                workflowDestination = workflowControl.getWorkflowDestinationByName(workflowStep, workflowDestinationName);
088                
089                if(workflowDestination == null) {
090                    var partyPK = getPartyPK();
091                    var isDefault = Boolean.valueOf(form.getIsDefault());
092                    var sortOrder = Integer.valueOf(form.getSortOrder());
093                    var description = form.getDescription();
094                    
095                    workflowDestination = workflowControl.createWorkflowDestination(workflowStep, workflowDestinationName, isDefault, sortOrder, partyPK);
096                    
097                    if(description != null) {
098                        workflowControl.createWorkflowDestinationDescription(workflowDestination, getPreferredLanguage(), description, partyPK);
099                    }
100                } else {
101                    addExecutionError(ExecutionErrors.UnknownWorkflowDestinationName.name(), workflowDestinationName);
102                }
103            } else {
104                addExecutionError(ExecutionErrors.UnknownWorkflowStepName.name(), workflowStepName);
105            }
106        } else {
107            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
108        }
109
110        if(workflowDestination != null) {
111            var basePK = workflowDestination.getPrimaryKey();
112            var workflowDestinationDetail = workflowDestination.getLastDetail();
113            var workflowStepDetail = workflowDestinationDetail.getWorkflowStep().getLastDetail();
114
115            result.setWorkflowName(workflowStepDetail.getWorkflow().getLastDetail().getWorkflowName());
116            result.setWorkflowStepName(workflowStepDetail.getWorkflowStepName());
117            result.setWorkflowDestinationName(workflowDestinationDetail.getWorkflowDestinationName());
118            result.setEntityRef(basePK.getEntityRef());
119        }
120
121        return result;
122    }
123    
124}