001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.GetWorkflowEntranceDescriptionForm;
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.Arrays;
037import java.util.Collections;
038import java.util.List;
039import javax.enterprise.context.RequestScoped;
040
041@RequestScoped
042public class GetWorkflowEntranceDescriptionCommand
043        extends BaseSimpleCommand<GetWorkflowEntranceDescriptionForm> {
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.WorkflowEntrance.name(), SecurityRoles.Description.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("WorkflowEntranceName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
060                ));
061    }
062    
063    /** Creates a new instance of GetWorkflowEntranceDescriptionCommand */
064    public GetWorkflowEntranceDescriptionCommand() {
065        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        var workflowControl = Session.getModelController(WorkflowControl.class);
071        var result = WorkflowResultFactory.getGetWorkflowEntranceDescriptionResult();
072        var workflowName = form.getWorkflowName();
073        var workflow = workflowControl.getWorkflowByName(workflowName);
074        
075        if(workflow != null) {
076            var workflowEntranceName = form.getWorkflowEntranceName();
077            var workflowEntrance = workflowControl.getWorkflowEntranceByName(workflow, workflowEntranceName);
078            
079            if(workflowEntrance != null) {
080                var partyControl = Session.getModelController(PartyControl.class);
081                var languageIsoName = form.getLanguageIsoName();
082                var language = partyControl.getLanguageByIsoName(languageIsoName);
083                
084                if(language != null) {
085                    var workflowEntranceDescription = workflowControl.getWorkflowEntranceDescription(workflowEntrance, language);
086                    
087                    if(workflowEntranceDescription != null) {
088                        result.setWorkflowEntranceDescription(workflowControl.getWorkflowEntranceDescriptionTransfer(getUserVisit(), workflowEntranceDescription));
089                    } else {
090                        addExecutionError(ExecutionErrors.UnknownWorkflowEntranceDescription.name(), workflowName, workflowEntranceName, languageIsoName);
091                    }
092                } else {
093                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
094                }
095            } else {
096                addExecutionError(ExecutionErrors.UnknownWorkflowEntranceName.name(), workflowName, workflowEntranceName);
097            }
098        } else {
099            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
100        }
101        
102        return result;
103    }
104    
105}