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.GetWorkflowDescriptionForm;
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 GetWorkflowDescriptionCommand
041        extends BaseSimpleCommand<GetWorkflowDescriptionForm> {
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.Workflow.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("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
057        );
058    }
059
060    @Inject
061    PartyControl partyControl;
062
063    @Inject
064    WorkflowControl workflowControl;
065
066    
067    /** Creates a new instance of GetWorkflowDescriptionCommand */
068    public GetWorkflowDescriptionCommand() {
069        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
070    }
071    
072    @Override
073    protected BaseResult execute() {
074        var result = WorkflowResultFactory.getGetWorkflowDescriptionResult();
075        var workflowName = form.getWorkflowName();
076        var workflow = workflowControl.getWorkflowByName(workflowName);
077        
078        if(workflow != null) {
079            var languageIsoName = form.getLanguageIsoName();
080            var language = partyControl.getLanguageByIsoName(languageIsoName);
081            
082            if(language != null) {
083                var workflowDescription = workflowControl.getWorkflowDescription(workflow, language);
084                
085                if(workflowDescription != null) {
086                    result.setWorkflowDescription(workflowControl.getWorkflowDescriptionTransfer(getUserVisit(), workflowDescription));
087                } else {
088                    addExecutionError(ExecutionErrors.UnknownWorkflowDescription.name(), workflowName, languageIsoName);
089                }
090            } else {
091                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
092            }
093        } else {
094            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
095        }
096        
097        return result;
098    }
099    
100}