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.GetWorkflowDestinationDescriptionForm;
020import com.echothree.control.user.workflow.common.result.WorkflowResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.party.server.control.PartyControl;
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.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 GetWorkflowDestinationDescriptionCommand
041        extends BaseSimpleCommand<GetWorkflowDestinationDescriptionForm> {
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.Description.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("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
059        );
060    }
061
062    @Inject
063    PartyControl partyControl;
064
065    @Inject
066    WorkflowControl workflowControl;
067
068    
069    /** Creates a new instance of GetWorkflowDestinationDescriptionCommand */
070    public GetWorkflowDestinationDescriptionCommand() {
071        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
072    }
073    
074    @Override
075    protected BaseResult execute() {
076        var result = WorkflowResultFactory.getGetWorkflowDestinationDescriptionResult();
077        var workflowName = form.getWorkflowName();
078        var workflow = workflowControl.getWorkflowByName(workflowName);
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                var workflowDestination = workflowControl.getWorkflowDestinationByName(workflowStep, workflowDestinationName);
087                
088                if(workflowDestination != null) {
089                    var languageIsoName = form.getLanguageIsoName();
090                    var language = partyControl.getLanguageByIsoName(languageIsoName);
091                    
092                    if(language != null) {
093                        var workflowDestinationDescription = workflowControl.getWorkflowDestinationDescription(workflowDestination, language);
094                        
095                        if(workflowDestinationDescription != null) {
096                            result.setWorkflowDestinationDescription(workflowControl.getWorkflowDestinationDescriptionTransfer(getUserVisit(), workflowDestinationDescription));
097                        } else {
098                            addExecutionError(ExecutionErrors.UnknownWorkflowDestinationDescription.name(), workflowName, workflowStepName, workflowDestinationName, languageIsoName);
099                        }
100                    } else {
101                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
102                    }
103                } else {
104                    addExecutionError(ExecutionErrors.UnknownWorkflowDestinationName.name(), workflowName, workflowStepName, workflowDestinationName);
105                }
106            } else {
107                addExecutionError(ExecutionErrors.UnknownWorkflowStepName.name(), workflowName, workflowStepName);
108            }
109        } else {
110            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
111        }
112        
113        return result;
114    }
115    
116}