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