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.GetWorkflowDestinationDescriptionsForm;
020import com.echothree.control.user.workflow.common.result.GetWorkflowDestinationDescriptionsResult;
021import com.echothree.control.user.workflow.common.result.WorkflowResultFactory;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.control.workflow.server.control.WorkflowControl;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.model.data.workflow.server.entity.Workflow;
028import com.echothree.model.data.workflow.server.entity.WorkflowDestination;
029import com.echothree.model.data.workflow.server.entity.WorkflowStep;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.common.command.BaseResult;
034import com.echothree.util.server.control.BaseSimpleCommand;
035import com.echothree.util.server.control.CommandSecurityDefinition;
036import com.echothree.util.server.control.PartyTypeDefinition;
037import com.echothree.util.server.control.SecurityRoleDefinition;
038import com.echothree.util.server.persistence.Session;
039import java.util.Arrays;
040import java.util.Collections;
041import java.util.List;
042
043public class GetWorkflowDestinationDescriptionsCommand
044        extends BaseSimpleCommand<GetWorkflowDestinationDescriptionsForm> {
045    
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048    
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
053                    new SecurityRoleDefinition(SecurityRoleGroups.WorkflowDestination.name(), SecurityRoles.Description.name())
054                    )))
055                )));
056
057        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
058                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("WorkflowStepName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("WorkflowDestinationName", FieldType.ENTITY_NAME, true, null, null)
061                ));
062    }
063    
064    /** Creates a new instance of GetWorkflowDestinationDescriptionsCommand */
065    public GetWorkflowDestinationDescriptionsCommand(UserVisitPK userVisitPK, GetWorkflowDestinationDescriptionsForm form) {
066        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        var workflowControl = Session.getModelController(WorkflowControl.class);
072        GetWorkflowDestinationDescriptionsResult result = WorkflowResultFactory.getGetWorkflowDestinationDescriptionsResult();
073        String workflowName = form.getWorkflowName();
074        var workflow = workflowControl.getWorkflowByName(workflowName);
075        
076        if(workflow != null) {
077            String workflowStepName = form.getWorkflowStepName();
078            var workflowStep = workflowControl.getWorkflowStepByName(workflow, workflowStepName);
079            
080            result.setWorkflow(workflowControl.getWorkflowTransfer(getUserVisit(), workflow));
081            
082            if(workflowStep != null) {
083                String workflowDestinationName = form.getWorkflowDestinationName();
084                WorkflowDestination workflowDestination = workflowControl.getWorkflowDestinationByName(workflowStep, workflowDestinationName);
085                
086                result.setWorkflowStep(workflowControl.getWorkflowStepTransfer(getUserVisit(), workflowStep));
087                
088                if(workflowDestination != null) {
089                    result.setWorkflowDestination(workflowControl.getWorkflowDestinationTransfer(getUserVisit(), workflowDestination));
090                    result.setWorkflowDestinationDescriptions(workflowControl.getWorkflowDestinationDescriptionTransfersByWorkflowDestination(getUserVisit(), workflowDestination));
091                } else {
092                    addExecutionError(ExecutionErrors.UnknownWorkflowDestinationName.name(), workflowDestinationName);
093                }
094            } else {
095                addExecutionError(ExecutionErrors.UnknownWorkflowStepName.name(), workflowStepName);
096            }
097        } else {
098            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
099        }
100        
101        return result;
102    }
103    
104}