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.GetWorkflowSelectorKindsForm;
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.selector.server.control.SelectorControl;
025import com.echothree.model.control.selector.server.logic.SelectorKindLogic;
026import com.echothree.model.control.workflow.server.control.WorkflowControl;
027import com.echothree.model.control.workflow.server.logic.WorkflowLogic;
028import com.echothree.model.data.selector.server.entity.SelectorKind;
029import com.echothree.model.data.workflow.server.entity.Workflow;
030import com.echothree.model.data.workflow.server.entity.WorkflowSelectorKind;
031import com.echothree.model.data.workflow.server.factory.WorkflowSelectorKindFactory;
032import com.echothree.util.common.command.BaseResult;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.validation.FieldDefinition;
035import com.echothree.util.common.validation.FieldType;
036import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import java.util.Collection;
041import java.util.List;
042import javax.enterprise.context.Dependent;
043import javax.inject.Inject;
044
045@Dependent
046public class GetWorkflowSelectorKindsCommand
047        extends BasePaginatedMultipleEntitiesCommand<WorkflowSelectorKind, GetWorkflowSelectorKindsForm> {
048    
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
051    
052    static {
053        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
054                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
055                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
056                        new SecurityRoleDefinition(SecurityRoleGroups.Workflow.name(), SecurityRoles.SelectorKind.name())
057                        ))
058                ));
059
060        FORM_FIELD_DEFINITIONS = List.of(
061                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, false, null, null),
062                new FieldDefinition("SelectorKindName", FieldType.ENTITY_NAME, false, null, null)
063        );
064    }
065    
066    /** Creates a new instance of GetWorkflowSelectorKindsCommand */
067    public GetWorkflowSelectorKindsCommand() {
068        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
069    }
070
071    @Inject
072    SelectorControl selectorControl;
073
074    @Inject
075    WorkflowControl workflowControl;
076
077    @Inject
078    WorkflowLogic workflowLogic;
079
080    @Inject
081    SelectorKindLogic selectorKindLogic;
082
083    Workflow workflow;
084    SelectorKind selectorKind;
085
086    @Override
087    protected void handleForm() {
088        var workflowName = form.getWorkflowName();
089        var selectorKindName = form.getSelectorKindName();
090        var parameterCount = (workflowName == null ? 0 : 1) + (selectorKindName == null ? 0 : 1);
091
092        if(parameterCount == 1) {
093            if(workflowName != null) {
094                workflow = workflowLogic.getWorkflowByName(this, workflowName);
095            } else {
096                selectorKind = selectorKindLogic.getSelectorKindByName(this, selectorKindName);
097            }
098        } else {
099            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
100        }
101    }
102
103    @Override
104    protected Long getTotalEntities() {
105        Long totalEntities = null;
106
107        if(!hasExecutionErrors()) {
108            if(workflow != null) {
109                totalEntities = workflowControl.countWorkflowSelectorKindsByWorkflow(workflow);
110            } else {
111                totalEntities = workflowControl.countWorkflowSelectorKindsBySelectorKind(selectorKind);
112            }
113        }
114
115        return totalEntities;
116    }
117
118    @Override
119    protected Collection<WorkflowSelectorKind> getEntities() {
120        Collection<WorkflowSelectorKind> workflowSelectorKinds = null;
121
122        if(!hasExecutionErrors()) {
123            if(workflow != null) {
124                workflowSelectorKinds = workflowControl.getWorkflowSelectorKindsByWorkflow(workflow);
125            } else {
126                workflowSelectorKinds = workflowControl.getWorkflowSelectorKindsBySelectorKind(selectorKind);
127            }
128        }
129
130        return workflowSelectorKinds;
131    }
132
133    @Override
134    protected BaseResult getResult(Collection<WorkflowSelectorKind> entities) {
135        var result = WorkflowResultFactory.getGetWorkflowSelectorKindsResult();
136
137        if(entities != null) {
138            var userVisit = getUserVisit();
139
140            if(workflow != null) {
141                result.setWorkflow(workflowControl.getWorkflowTransfer(userVisit, workflow));
142            }
143
144            if(selectorKind != null) {
145                result.setSelectorKind(selectorControl.getSelectorKindTransfer(userVisit, selectorKind));
146            }
147
148            if(session.hasLimit(WorkflowSelectorKindFactory.class)) {
149                result.setWorkflowSelectorKindCount(getTotalEntities());
150            }
151
152            result.setWorkflowSelectorKinds(workflowControl.getWorkflowSelectorKindTransfers(userVisit, entities));
153        }
154
155        return result;
156    }
157    
158}