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 com.echothree.util.server.persistence.Session;
036import java.util.List;
037import javax.enterprise.context.Dependent;
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    /** Creates a new instance of GetWorkflowDestinationDescriptionCommand */
063    public GetWorkflowDestinationDescriptionCommand() {
064        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var workflowControl = Session.getModelController(WorkflowControl.class);
070        var result = WorkflowResultFactory.getGetWorkflowDestinationDescriptionResult();
071        var workflowName = form.getWorkflowName();
072        var workflow = workflowControl.getWorkflowByName(workflowName);
073        
074        if(workflow != null) {
075            var workflowStepName = form.getWorkflowStepName();
076            var workflowStep = workflowControl.getWorkflowStepByName(workflow, workflowStepName);
077            
078            if(workflowStep != null) {
079                var workflowDestinationName = form.getWorkflowDestinationName();
080                var workflowDestination = workflowControl.getWorkflowDestinationByName(workflowStep, workflowDestinationName);
081                
082                if(workflowDestination != null) {
083                    var partyControl = Session.getModelController(PartyControl.class);
084                    var languageIsoName = form.getLanguageIsoName();
085                    var language = partyControl.getLanguageByIsoName(languageIsoName);
086                    
087                    if(language != null) {
088                        var workflowDestinationDescription = workflowControl.getWorkflowDestinationDescription(workflowDestination, language);
089                        
090                        if(workflowDestinationDescription != null) {
091                            result.setWorkflowDestinationDescription(workflowControl.getWorkflowDestinationDescriptionTransfer(getUserVisit(), workflowDestinationDescription));
092                        } else {
093                            addExecutionError(ExecutionErrors.UnknownWorkflowDestinationDescription.name(), workflowName, workflowStepName, workflowDestinationName, languageIsoName);
094                        }
095                    } else {
096                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
097                    }
098                } else {
099                    addExecutionError(ExecutionErrors.UnknownWorkflowDestinationName.name(), workflowName, workflowStepName, workflowDestinationName);
100                }
101            } else {
102                addExecutionError(ExecutionErrors.UnknownWorkflowStepName.name(), workflowName, workflowStepName);
103            }
104        } else {
105            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
106        }
107        
108        return result;
109    }
110    
111}