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.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.user.common.pk.UserVisitPK;
027import com.echothree.model.data.workflow.server.entity.WorkflowDestination;
028import com.echothree.model.data.workflow.server.entity.WorkflowDestinationSelector;
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.BaseMultipleEntitiesCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import com.echothree.util.server.persistence.Session;
037import java.util.Arrays;
038import java.util.Collection;
039import java.util.Collections;
040import java.util.List;
041
042public class GetWorkflowDestinationSelectorsCommand
043        extends BaseMultipleEntitiesCommand<WorkflowDestinationSelector, GetWorkflowDestinationSelectorsForm> {
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(Collections.unmodifiableList(Arrays.asList(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                        new SecurityRoleDefinition(SecurityRoleGroups.WorkflowDestination.name(), SecurityRoles.Selector.name())
053                        )))
054                )));
055
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("WorkflowStepName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("WorkflowDestinationName", FieldType.ENTITY_NAME, true, null, null)
060                ));
061    }
062    
063    /** Creates a new instance of GetWorkflowDestinationSelectorsCommand */
064    public GetWorkflowDestinationSelectorsCommand(UserVisitPK userVisitPK, GetWorkflowDestinationSelectorsForm form) {
065        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
066    }
067    
068    WorkflowDestination workflowDestination;
069
070    @Override
071    protected Collection<WorkflowDestinationSelector> getEntities() {
072        var workflowName = form.getWorkflowName();
073        var workflowStepName = form.getWorkflowStepName();
074        var workflowDestinationName = form.getWorkflowDestinationName();
075        Collection<WorkflowDestinationSelector> workflowDestinationSelectors = null;
076
077        workflowDestination = WorkflowDestinationLogic.getInstance().getWorkflowDestinationByName(this, workflowName,
078                workflowStepName, workflowDestinationName);
079
080        if(!hasExecutionErrors()) {
081            var workflowControl = Session.getModelController(WorkflowControl.class);
082
083            workflowDestinationSelectors = workflowControl.getWorkflowDestinationSelectorsByWorkflowDestination(workflowDestination);
084        }
085
086        return workflowDestinationSelectors;
087    }
088
089    @Override
090    protected BaseResult getResult(Collection<WorkflowDestinationSelector> entities) {
091        var result = WorkflowResultFactory.getGetWorkflowDestinationSelectorsResult();
092
093        if(entities != null) {
094            var workflowControl = Session.getModelController(WorkflowControl.class);
095            var userVisit = getUserVisit();
096
097            result.setWorkflowDestination(workflowControl.getWorkflowDestinationTransfer(userVisit, workflowDestination));
098            result.setWorkflowDestinationSelectors(workflowControl.getWorkflowDestinationSelectorTransfers(userVisit, entities));
099        }
100
101        return result;
102    }
103    
104}