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.GetWorkflowDestinationSelectorsForm;
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.workflow.server.entity.WorkflowDestination;
027import com.echothree.model.data.workflow.server.entity.WorkflowDestinationSelector;
028import com.echothree.model.data.workflow.server.factory.WorkflowDestinationSelectorFactory;
029import com.echothree.model.data.workflow.server.factory.WorkflowStepFactory;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import java.util.Collection;
038import java.util.List;
039import javax.enterprise.context.Dependent;
040import javax.inject.Inject;
041
042@Dependent
043public class GetWorkflowDestinationSelectorsCommand
044        extends BasePaginatedMultipleEntitiesCommand<WorkflowDestinationSelector, GetWorkflowDestinationSelectorsForm> {
045    
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048    
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
053                        new SecurityRoleDefinition(SecurityRoleGroups.WorkflowDestination.name(), SecurityRoles.Selector.name())
054                ))
055        ));
056
057        FORM_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("WorkflowStepName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("WorkflowDestinationName", FieldType.ENTITY_NAME, true, null, null)
061        );
062    }
063
064    @Inject
065    WorkflowControl workflowControl;
066
067    @Inject
068    WorkflowDestinationLogic workflowDestinationLogic;
069
070
071    /** Creates a new instance of GetWorkflowDestinationSelectorsCommand */
072    public GetWorkflowDestinationSelectorsCommand() {
073        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
074    }
075
076    
077    WorkflowDestination workflowDestination;
078
079    @Override
080    protected void handleForm() {
081        var workflowName = form.getWorkflowName();
082        var workflowStepName = form.getWorkflowStepName();
083        var workflowDestinationName = form.getWorkflowDestinationName();
084
085        workflowDestination = workflowDestinationLogic.getWorkflowDestinationByName(this, workflowName,
086                workflowStepName, workflowDestinationName);
087    }
088
089    @Override
090    protected Long getTotalEntities() {
091        return workflowDestination == null ? null : workflowControl.countWorkflowDestinationSelectorsByWorkflowDestination(workflowDestination);
092    }
093
094    @Override
095    protected Collection<WorkflowDestinationSelector> getEntities() {
096        return workflowDestination == null ? null : workflowControl.getWorkflowDestinationSelectorsByWorkflowDestination(workflowDestination);
097    }
098
099    @Override
100    protected BaseResult getResult(Collection<WorkflowDestinationSelector> entities) {
101        var result = WorkflowResultFactory.getGetWorkflowDestinationSelectorsResult();
102
103        if(entities != null) {
104            var userVisit = getUserVisit();
105
106            result.setWorkflowDestination(workflowControl.getWorkflowDestinationTransfer(userVisit, workflowDestination));
107
108            if(session.hasLimit(WorkflowDestinationSelectorFactory.class)) {
109                result.setWorkflowDestinationSelectorCount(getTotalEntities());
110            }
111
112            result.setWorkflowDestinationSelectors(workflowControl.getWorkflowDestinationSelectorTransfers(userVisit, entities));
113        }
114
115        return result;
116    }
117    
118}