001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.GetWorkflowDestinationStepsForm;
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.WorkflowDestinationLogic;
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.WorkflowDestinationStep;
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 java.util.Collection;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
042public class GetWorkflowDestinationStepsCommand
043        extends BasePaginatedMultipleEntitiesCommand<WorkflowDestinationStep, GetWorkflowDestinationStepsForm> {
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.WorkflowStep.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                new FieldDefinition("WorkflowDestinationName", FieldType.ENTITY_NAME, true, null, null)
060        );
061    }
062
063    @Inject
064    WorkflowControl workflowControl;
065
066    @Inject
067    WorkflowDestinationLogic workflowDestinationLogic;
068
069    
070    /** Creates a new instance of GetWorkflowDestinationStepsCommand */
071    public GetWorkflowDestinationStepsCommand() {
072        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
073    }
074    
075    WorkflowDestination workflowDestination;
076
077    @Override
078    protected void handleForm() {
079        var workflowName = form.getWorkflowName();
080        var workflowStepName = form.getWorkflowStepName();
081        var workflowDestinationName = form.getWorkflowDestinationName();
082
083        workflowDestination = workflowDestinationLogic.getWorkflowDestinationByName(this, workflowName,
084                workflowStepName, workflowDestinationName);
085    }
086
087    @Override
088    protected Long getTotalEntities() {
089        return hasExecutionErrors() ? null :
090                workflowControl.countWorkflowDestinationStepsByWorkflowDestination(workflowDestination);
091    }
092
093    @Override
094    protected Collection<WorkflowDestinationStep> getEntities() {
095        Collection<WorkflowDestinationStep> workflowDestinationSteps = null;
096
097        if(!hasExecutionErrors()) {
098            workflowDestinationSteps = workflowControl.getWorkflowDestinationStepsByWorkflowDestination(workflowDestination);
099        }
100
101        return workflowDestinationSteps;
102    }
103
104    @Override
105    protected BaseResult getResult(Collection<WorkflowDestinationStep> entities) {
106        var result = WorkflowResultFactory.getGetWorkflowDestinationStepsResult();
107
108        if(entities != null) {
109            var userVisit = getUserVisit();
110
111            result.setWorkflowDestination(workflowControl.getWorkflowDestinationTransfer(userVisit, workflowDestination));
112            result.setWorkflowDestinationSteps(workflowControl.getWorkflowDestinationStepTransfers(userVisit, entities));
113        }
114
115        return result;
116    }
117    
118}