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.GetWorkflowEntranceSelectorsForm;
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.WorkflowEntranceLogic;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.model.data.workflow.server.entity.WorkflowEntrance;
028import com.echothree.model.data.workflow.server.entity.WorkflowEntranceSelector;
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 GetWorkflowEntranceSelectorsCommand
043        extends BaseMultipleEntitiesCommand<WorkflowEntranceSelector, GetWorkflowEntranceSelectorsForm> {
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.WorkflowEntrance.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("WorkflowEntranceName", FieldType.ENTITY_NAME, true, null, null)
059                ));
060    }
061    
062    /** Creates a new instance of GetWorkflowEntranceSelectorsCommand */
063    public GetWorkflowEntranceSelectorsCommand(UserVisitPK userVisitPK, GetWorkflowEntranceSelectorsForm form) {
064        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
065    }
066
067    WorkflowEntrance workflowEntrance;
068
069    @Override
070    protected Collection<WorkflowEntranceSelector> getEntities() {
071        var workflowName = form.getWorkflowName();
072        var workflowEntranceName = form.getWorkflowEntranceName();
073        Collection<WorkflowEntranceSelector> workflowEntranceSelectors = null;
074
075        workflowEntrance = WorkflowEntranceLogic.getInstance().getWorkflowEntranceByName(this,
076                workflowName, workflowEntranceName);
077
078        if(!hasExecutionErrors()) {
079            var workflowControl = Session.getModelController(WorkflowControl.class);
080
081            workflowEntranceSelectors = workflowControl.getWorkflowEntranceSelectorsByWorkflowEntrance(workflowEntrance);
082        }
083
084        return workflowEntranceSelectors;
085    }
086
087    @Override
088    protected BaseResult getResult(Collection<WorkflowEntranceSelector> entities) {
089        var result = WorkflowResultFactory.getGetWorkflowEntranceSelectorsResult();
090
091        if(entities != null) {
092            var workflowControl = Session.getModelController(WorkflowControl.class);
093            var userVisit = getUserVisit();
094
095            result.setWorkflowEntrance(workflowControl.getWorkflowEntranceTransfer(userVisit, workflowEntrance));
096            result.setWorkflowEntranceSelectors(workflowControl.getWorkflowEntranceSelectorTransfers(userVisit, entities));
097        }
098
099        return result;
100    }
101
102}