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.GetWorkflowForm;
020import com.echothree.control.user.workflow.common.result.WorkflowResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
022import com.echothree.model.control.party.common.PartyTypes;
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.control.workflow.server.logic.WorkflowLogic;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.model.data.workflow.server.entity.Workflow;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BaseSingleEntityCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import com.echothree.util.server.persistence.Session;
037import java.util.List;
038import javax.enterprise.context.RequestScoped;
039
040@RequestScoped
041public class GetWorkflowCommand
042        extends BaseSingleEntityCommand<Workflow, GetWorkflowForm> {
043    
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
051                        new SecurityRoleDefinition(SecurityRoleGroups.Workflow.name(), SecurityRoles.Review.name())
052                ))
053        ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
058                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
059        );
060    }
061    
062    /** Creates a new instance of GetWorkflowCommand */
063    public GetWorkflowCommand() {
064        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
065    }
066    
067    @Override
068    protected Workflow getEntity() {
069        var workflow = WorkflowLogic.getInstance().getWorkflowByUniversalSpec(this, form);
070
071        if(workflow != null) {
072            sendEvent(workflow.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
073        }
074
075        return workflow;
076    }
077
078    @Override
079    protected BaseResult getResult(Workflow workflow) {
080        var result = WorkflowResultFactory.getGetWorkflowResult();
081
082        if(workflow != null) {
083            var workflowControl = Session.getModelController(WorkflowControl.class);
084
085            result.setWorkflow(workflowControl.getWorkflowTransfer(getUserVisit(), workflow));
086        }
087
088        return result;
089    }
090
091}