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.GetWorkflowEntranceSelectorsForm;
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.workflow.server.entity.WorkflowEntrance;
027import com.echothree.model.data.workflow.server.entity.WorkflowEntranceSelector;
028import com.echothree.model.data.workflow.server.factory.WorkflowEntranceSelectorFactory;
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 GetWorkflowEntranceSelectorsCommand
043        extends BasePaginatedMultipleEntitiesCommand<WorkflowEntranceSelector, GetWorkflowEntranceSelectorsForm> {
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.Selector.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    @Inject
063    WorkflowControl workflowControl;
064
065    @Inject
066    WorkflowEntranceLogic workflowEntranceLogic;
067
068
069    /** Creates a new instance of GetWorkflowEntranceSelectorsCommand */
070    public GetWorkflowEntranceSelectorsCommand() {
071        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
072    }
073
074    WorkflowEntrance workflowEntrance;
075
076    @Override
077    protected void handleForm() {
078        var workflowName = form.getWorkflowName();
079        var workflowEntranceName = form.getWorkflowEntranceName();
080
081        workflowEntrance = workflowEntranceLogic.getWorkflowEntranceByName(this, workflowName, workflowEntranceName);
082    }
083
084    @Override
085    protected Long getTotalEntities() {
086        return workflowEntrance == null ? null : workflowControl.countWorkflowEntranceSelectorsByWorkflowEntrance(workflowEntrance);
087    }
088
089    @Override
090    protected Collection<WorkflowEntranceSelector> getEntities() {
091        return workflowEntrance == null ? null : workflowControl.getWorkflowEntranceSelectorsByWorkflowEntrance(workflowEntrance);
092    }
093
094    @Override
095    protected BaseResult getResult(Collection<WorkflowEntranceSelector> entities) {
096        var result = WorkflowResultFactory.getGetWorkflowEntranceSelectorsResult();
097
098        if(entities != null) {
099            var userVisit = getUserVisit();
100
101            result.setWorkflowEntrance(workflowControl.getWorkflowEntranceTransfer(userVisit, workflowEntrance));
102
103            if(session.hasLimit(WorkflowEntranceSelectorFactory.class)) {
104                result.setWorkflowEntranceSelectorCount(getTotalEntities());
105            }
106
107            result.setWorkflowEntranceSelectors(workflowControl.getWorkflowEntranceSelectorTransfers(userVisit, entities));
108        }
109
110        return result;
111    }
112
113}