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.GetWorkflowDestinationStepsForm;
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.WorkflowDestinationStep;
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.BasePaginatedMultipleEntitiesCommand;
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.Collection;
038import java.util.List;
039
040public class GetWorkflowDestinationStepsCommand
041        extends BasePaginatedMultipleEntitiesCommand<WorkflowDestinationStep, GetWorkflowDestinationStepsForm> {
042
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.WorkflowDestination.name(), SecurityRoles.WorkflowStep.name())
051                ))
052        ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("WorkflowStepName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("WorkflowDestinationName", FieldType.ENTITY_NAME, true, null, null)
058        );
059    }
060    
061    /** Creates a new instance of GetWorkflowDestinationStepsCommand */
062    public GetWorkflowDestinationStepsCommand(UserVisitPK userVisitPK, GetWorkflowDestinationStepsForm form) {
063        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
064    }
065    
066    WorkflowDestination workflowDestination;
067
068    @Override
069    protected void handleForm() {
070        var workflowName = form.getWorkflowName();
071        var workflowStepName = form.getWorkflowStepName();
072        var workflowDestinationName = form.getWorkflowDestinationName();
073
074        workflowDestination = WorkflowDestinationLogic.getInstance().getWorkflowDestinationByName(this, workflowName,
075                workflowStepName, workflowDestinationName);
076    }
077
078    @Override
079    protected Long getTotalEntities() {
080        var workflowControl = Session.getModelController(WorkflowControl.class);
081
082        return hasExecutionErrors() ? null :
083                workflowControl.countWorkflowDestinationStepsByWorkflowDestination(workflowDestination);
084    }
085
086    @Override
087    protected Collection<WorkflowDestinationStep> getEntities() {
088        Collection<WorkflowDestinationStep> workflowDestinationSteps = null;
089
090        if(!hasExecutionErrors()) {
091            var workflowControl = Session.getModelController(WorkflowControl.class);
092
093            workflowDestinationSteps = workflowControl.getWorkflowDestinationStepsByWorkflowDestination(workflowDestination);
094        }
095
096        return workflowDestinationSteps;
097    }
098
099    @Override
100    protected BaseResult getResult(Collection<WorkflowDestinationStep> entities) {
101        var result = WorkflowResultFactory.getGetWorkflowDestinationStepsResult();
102
103        if(entities != null) {
104            var workflowControl = Session.getModelController(WorkflowControl.class);
105            var userVisit = getUserVisit();
106
107            result.setWorkflowDestination(workflowControl.getWorkflowDestinationTransfer(userVisit, workflowDestination));
108            result.setWorkflowDestinationSteps(workflowControl.getWorkflowDestinationStepTransfers(userVisit, entities));
109        }
110
111        return result;
112    }
113    
114}