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    @Inject
067    SelectorControl selectorControl;
068
069    @Inject
070    WorkflowControl workflowControl;
071
072    @Inject
073    SelectorKindLogic selectorKindLogic;
074
075    @Inject
076    WorkflowLogic workflowLogic;
077
078
079    /** Creates a new instance of GetWorkflowSelectorKindsCommand */
080    public GetWorkflowSelectorKindsCommand() {
081        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
082    }
083
084    Workflow workflow;
085    SelectorKind selectorKind;
086
087    @Override
088    protected void handleForm() {
089        var workflowName = form.getWorkflowName();
090        var selectorKindName = form.getSelectorKindName();
091        var parameterCount = (workflowName == null ? 0 : 1) + (selectorKindName == null ? 0 : 1);
092
093        if(parameterCount == 1) {
094            if(workflowName != null) {
095                workflow = workflowLogic.getWorkflowByName(this, workflowName);
096            } else {
097                selectorKind = selectorKindLogic.getSelectorKindByName(this, selectorKindName);
098            }
099        } else {
100            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
101        }
102    }
103
104    @Override
105    protected Long getTotalEntities() {
106        Long totalEntities = null;
107
108        if(!hasExecutionErrors()) {
109            if(workflow != null) {
110                totalEntities = workflowControl.countWorkflowSelectorKindsByWorkflow(workflow);
111            } else {
112                totalEntities = workflowControl.countWorkflowSelectorKindsBySelectorKind(selectorKind);
113            }
114        }
115
116        return totalEntities;
117    }
118
119    @Override
120    protected Collection<WorkflowSelectorKind> getEntities() {
121        Collection<WorkflowSelectorKind> workflowSelectorKinds = null;
122
123        if(!hasExecutionErrors()) {
124            if(workflow != null) {
125                workflowSelectorKinds = workflowControl.getWorkflowSelectorKindsByWorkflow(workflow);
126            } else {
127                workflowSelectorKinds = workflowControl.getWorkflowSelectorKindsBySelectorKind(selectorKind);
128            }
129        }
130
131        return workflowSelectorKinds;
132    }
133
134    @Override
135    protected BaseResult getResult(Collection<WorkflowSelectorKind> entities) {
136        var result = WorkflowResultFactory.getGetWorkflowSelectorKindsResult();
137
138        if(entities != null) {
139            var userVisit = getUserVisit();
140
141            if(workflow != null) {
142                result.setWorkflow(workflowControl.getWorkflowTransfer(userVisit, workflow));
143            }
144
145            if(selectorKind != null) {
146                result.setSelectorKind(selectorControl.getSelectorKindTransfer(userVisit, selectorKind));
147            }
148
149            if(session.hasLimit(WorkflowSelectorKindFactory.class)) {
150                result.setWorkflowSelectorKindCount(getTotalEntities());
151            }
152
153            result.setWorkflowSelectorKinds(workflowControl.getWorkflowSelectorKindTransfers(userVisit, entities));
154        }
155
156        return result;
157    }
158    
159}