001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.user.common.pk.UserVisitPK;
030import com.echothree.model.data.workflow.server.entity.Workflow;
031import com.echothree.model.data.workflow.server.entity.WorkflowSelectorKind;
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.BaseMultipleEntitiesCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import com.echothree.util.server.persistence.Session;
041import java.util.Arrays;
042import java.util.Collection;
043import java.util.Collections;
044import java.util.List;
045
046public class GetWorkflowSelectorKindsCommand
047        extends BaseMultipleEntitiesCommand<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(Collections.unmodifiableList(Arrays.asList(
054                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
055                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
056                        new SecurityRoleDefinition(SecurityRoleGroups.Workflow.name(), SecurityRoles.SelectorKind.name())
057                        )))
058                )));
059
060        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
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(UserVisitPK userVisitPK, GetWorkflowSelectorKindsForm form) {
068        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
069    }
070
071    Workflow workflow;
072    SelectorKind selectorKind;
073
074    @Override
075    protected Collection<WorkflowSelectorKind> getEntities() {
076        var workflowName = form.getWorkflowName();
077        var selectorKindName = form.getSelectorKindName();
078        var parameterCount = (workflowName == null ? 0 : 1) + (selectorKindName == null ? 0 : 1);
079        Collection<WorkflowSelectorKind> workflowSelectorKinds = null;
080
081        if(parameterCount == 1) {
082            var workflowControl = Session.getModelController(WorkflowControl.class);
083
084            if(workflowName != null) {
085                workflow = WorkflowLogic.getInstance().getWorkflowByName(this, workflowName);
086
087                if(!hasExecutionErrors()) {
088                    workflowSelectorKinds = workflowControl.getWorkflowSelectorKindsByWorkflow(workflow);
089                }
090            } else {
091                selectorKind = SelectorKindLogic.getInstance().getSelectorKindByName(this, selectorKindName);
092
093                if(!hasExecutionErrors()) {
094                    workflowSelectorKinds = workflowControl.getWorkflowSelectorKindsBySelectorKind(selectorKind);
095                }
096            }
097
098        } else {
099            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
100        }
101
102        return workflowSelectorKinds;
103    }
104
105    @Override
106    protected BaseResult getResult(Collection<WorkflowSelectorKind> entities) {
107        var result = WorkflowResultFactory.getGetWorkflowSelectorKindsResult();
108
109        if(entities != null) {
110            var workflowControl = Session.getModelController(WorkflowControl.class);
111            var userVisit = getUserVisit();
112
113            result.setWorkflow(workflowControl == null ? null : workflowControl.getWorkflowTransfer(userVisit, workflow));
114
115            if(selectorKind != null) {
116                var selectorControl = Session.getModelController(SelectorControl.class);
117
118                result.setSelectorKind(selectorControl.getSelectorKindTransfer(userVisit, selectorKind));
119            }
120
121            result.setWorkflowSelectorKinds(workflowControl.getWorkflowSelectorKindTransfers(userVisit, entities));
122        }
123
124        return result;
125    }
126    
127}