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.GetWorkflowStepForm;
020import com.echothree.control.user.workflow.common.result.WorkflowResultFactory;
021import com.echothree.model.control.workflow.server.control.WorkflowControl;
022import com.echothree.model.control.workflow.server.logic.WorkflowStepLogic;
023import com.echothree.model.data.user.common.pk.UserVisitPK;
024import com.echothree.model.data.workflow.server.entity.WorkflowStep;
025import com.echothree.util.common.command.BaseResult;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.server.control.BaseSingleEntityCommand;
029import com.echothree.util.server.persistence.Session;
030import java.util.List;
031import javax.enterprise.context.RequestScoped;
032
033@RequestScoped
034public class GetWorkflowStepCommand
035        extends BaseSingleEntityCommand<WorkflowStep, GetWorkflowStepForm> {
036    
037    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
038    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
039    
040    static {
041        FORM_FIELD_DEFINITIONS = List.of(
042                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, false, null, null),
043                new FieldDefinition("WorkflowStepName", FieldType.ENTITY_NAME, false, null, null),
044                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
045                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
046        );
047    }
048    
049    /** Creates a new instance of GetWorkflowStepCommand */
050    public GetWorkflowStepCommand() {
051        super(null, FORM_FIELD_DEFINITIONS, true);
052    }
053    
054    @Override
055    protected WorkflowStep getEntity() {
056        return WorkflowStepLogic.getInstance().getWorkflowStepByUniversalSpec(this, form, true);
057    }
058
059    @Override
060    protected BaseResult getResult(WorkflowStep workflowStep) {
061        var result = WorkflowResultFactory.getGetWorkflowStepResult();
062
063        if(workflowStep != null) {
064            var workflowControl = Session.getModelController(WorkflowControl.class);
065
066            result.setWorkflowStep(workflowControl.getWorkflowStepTransfer(getUserVisit(), workflowStep));
067        }
068
069        return result;
070    }
071    
072}