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.GetWorkflowEntranceStepsForm;
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.WorkflowEntranceLogic;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.model.data.workflow.server.entity.WorkflowEntrance;
028import com.echothree.model.data.workflow.server.entity.WorkflowEntranceStep;
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 GetWorkflowEntranceStepsCommand
043        extends BasePaginatedMultipleEntitiesCommand<WorkflowEntranceStep, GetWorkflowEntranceStepsForm> {
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.WorkflowEntrance.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("WorkflowEntranceName", FieldType.ENTITY_NAME, true, null, null)
059        );
060    }
061    
062    /** Creates a new instance of GetWorkflowEntranceStepsCommand */
063    public GetWorkflowEntranceStepsCommand() {
064        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
065    }
066
067    WorkflowEntrance workflowEntrance;
068
069    @Override
070    protected void handleForm() {
071        var workflowName = form.getWorkflowName();
072        var workflowEntranceName = form.getWorkflowEntranceName();
073
074        workflowEntrance = WorkflowEntranceLogic.getInstance().getWorkflowEntranceByName(this,
075                workflowName, workflowEntranceName);
076    }
077
078    @Override
079    protected Long getTotalEntities() {
080        var workflowControl = Session.getModelController(WorkflowControl.class);
081
082        return hasExecutionErrors() ? null :
083                workflowControl.countWorkflowEntranceStepsByWorkflowEntrance(workflowEntrance);
084    }
085
086    @Override
087    protected Collection<WorkflowEntranceStep> getEntities() {
088        Collection<WorkflowEntranceStep> workflowEntranceSteps = null;
089
090        if(!hasExecutionErrors()) {
091            var workflowControl = Session.getModelController(WorkflowControl.class);
092
093            workflowEntranceSteps = workflowControl.getWorkflowEntranceStepsByWorkflowEntrance(workflowEntrance);
094        }
095
096        return workflowEntranceSteps;
097    }
098
099    @Override
100    protected BaseResult getResult(Collection<WorkflowEntranceStep> entities) {
101        var result = WorkflowResultFactory.getGetWorkflowEntranceStepsResult();
102
103        if(entities != null) {
104            var workflowControl = Session.getModelController(WorkflowControl.class);
105            var userVisit = getUserVisit();
106
107            result.setWorkflowEntrance(workflowControl.getWorkflowEntranceTransfer(userVisit, workflowEntrance));
108            result.setWorkflowEntranceSteps(workflowControl.getWorkflowEntranceStepTransfers(userVisit, entities));
109        }
110
111        return result;
112    }
113    
114}