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