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.GetWorkflowDestinationsForm;
020import com.echothree.control.user.workflow.common.result.WorkflowResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.control.workflow.server.control.WorkflowControl;
025import com.echothree.model.control.workflow.server.logic.WorkflowStepLogic;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.model.data.workflow.server.entity.WorkflowDestination;
028import com.echothree.model.data.workflow.server.entity.WorkflowStep;
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.BasePaginatedMultipleEntitiesCommand;
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.Collection;
038import java.util.List;
039import javax.enterprise.context.RequestScoped;
040
041@RequestScoped
042public class GetWorkflowDestinationsCommand
043        extends BasePaginatedMultipleEntitiesCommand<WorkflowDestination, GetWorkflowDestinationsForm> {
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(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.WorkflowDestination.name(), SecurityRoles.List.name())
053                ))
054        ));
055
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("WorkflowStepName", FieldType.ENTITY_NAME, true, null, null)
059        );
060    }
061    
062    /** Creates a new instance of GetWorkflowDestinationsCommand */
063    public GetWorkflowDestinationsCommand() {
064        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
065    }
066    
067    WorkflowStep workflowStep;
068
069    @Override
070    protected void handleForm() {
071        var workflowName = form.getWorkflowName();
072        var workflowStepName = form.getWorkflowStepName();
073
074        workflowStep = WorkflowStepLogic.getInstance().getWorkflowStepByName(this, workflowName, workflowStepName);
075    }
076
077    @Override
078    protected Long getTotalEntities() {
079        var workflowControl = Session.getModelController(WorkflowControl.class);
080
081        return hasExecutionErrors() ? null :
082                workflowControl.countWorkflowDestinationsByWorkflowStep(workflowStep);
083    }
084
085    @Override
086    protected Collection<WorkflowDestination> getEntities() {
087        Collection<WorkflowDestination> workflowDestinations = null;
088
089        if(!hasExecutionErrors()) {
090            var workflowControl = Session.getModelController(WorkflowControl.class);
091
092            workflowDestinations = workflowControl.getWorkflowDestinationsByWorkflowStep(workflowStep);
093        }
094
095        return workflowDestinations;
096    }
097
098    @Override
099    protected BaseResult getResult(Collection<WorkflowDestination> entities) {
100        var result = WorkflowResultFactory.getGetWorkflowDestinationsResult();
101
102        if(entities != null) {
103            var workflowControl = Session.getModelController(WorkflowControl.class);
104            var userVisit = getUserVisit();
105
106            result.setWorkflowStep(workflowControl.getWorkflowStepTransfer(userVisit, workflowStep));
107            result.setWorkflowDestinations(workflowControl.getWorkflowDestinationTransfers(getUserVisit(), entities));
108        }
109
110        return result;
111    }
112
113}