001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.filter.server.logic.FilterKindLogic;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.control.workflow.server.control.WorkflowControl;
027import com.echothree.model.control.workflow.server.logic.WorkflowLogic;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.model.data.workflow.server.entity.Workflow;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BaseSingleEntityCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import com.echothree.util.server.persistence.Session;
038import java.util.List;
039
040public class GetWorkflowCommand
041        extends BaseSingleEntityCommand<Workflow, GetWorkflowForm> {
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.Review.name())
051                ))
052        ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, false, null, null),
056                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
057                new FieldDefinition("Key", FieldType.KEY, false, null, null),
058                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
059                new FieldDefinition("Ulid", FieldType.ULID, false, null, null)
060        );
061    }
062    
063    /** Creates a new instance of GetWorkflowCommand */
064    public GetWorkflowCommand(UserVisitPK userVisitPK, GetWorkflowForm form) {
065        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
066    }
067    
068    @Override
069    protected Workflow getEntity() {
070        var workflow = WorkflowLogic.getInstance().getWorkflowByUniversalSpec(this, form);
071
072        if(workflow != null) {
073            sendEvent(workflow.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
074        }
075
076        return workflow;
077    }
078
079    @Override
080    protected BaseResult getResult(Workflow workflow) {
081        var result = WorkflowResultFactory.getGetWorkflowResult();
082
083        if(workflow != null) {
084            var workflowControl = Session.getModelController(WorkflowControl.class);
085
086            result.setWorkflow(workflowControl.getWorkflowTransfer(getUserVisit(), workflow));
087        }
088
089        return result;
090    }
091
092}