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.GetWorkflowEntranceStepsForm;
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.WorkflowEntranceStep;
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 GetWorkflowEntranceStepsCommand
041        extends BasePaginatedMultipleEntitiesCommand<WorkflowEntranceStep, GetWorkflowEntranceStepsForm> {
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.WorkflowEntrance.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("WorkflowEntranceName", FieldType.ENTITY_NAME, true, null, null)
057        );
058    }
059    
060    /** Creates a new instance of GetWorkflowEntranceStepsCommand */
061    public GetWorkflowEntranceStepsCommand(UserVisitPK userVisitPK, GetWorkflowEntranceStepsForm form) {
062        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
063    }
064
065    WorkflowEntrance workflowEntrance;
066
067    @Override
068    protected void handleForm() {
069        var workflowName = form.getWorkflowName();
070        var workflowEntranceName = form.getWorkflowEntranceName();
071
072        workflowEntrance = WorkflowEntranceLogic.getInstance().getWorkflowEntranceByName(this,
073                workflowName, workflowEntranceName);
074    }
075
076    @Override
077    protected Long getTotalEntities() {
078        var workflowControl = Session.getModelController(WorkflowControl.class);
079
080        return hasExecutionErrors() ? null :
081                workflowControl.countWorkflowEntranceStepsByWorkflowEntrance(workflowEntrance);
082    }
083
084    @Override
085    protected Collection<WorkflowEntranceStep> getEntities() {
086        Collection<WorkflowEntranceStep> workflowEntranceSteps = null;
087
088        if(!hasExecutionErrors()) {
089            var workflowControl = Session.getModelController(WorkflowControl.class);
090
091            workflowEntranceSteps = workflowControl.getWorkflowEntranceStepsByWorkflowEntrance(workflowEntrance);
092        }
093
094        return workflowEntranceSteps;
095    }
096
097    @Override
098    protected BaseResult getResult(Collection<WorkflowEntranceStep> entities) {
099        var result = WorkflowResultFactory.getGetWorkflowEntranceStepsResult();
100
101        if(entities != null) {
102            var workflowControl = Session.getModelController(WorkflowControl.class);
103            var userVisit = getUserVisit();
104
105            result.setWorkflowEntrance(workflowControl.getWorkflowEntranceTransfer(userVisit, workflowEntrance));
106            result.setWorkflowEntranceSteps(workflowControl.getWorkflowEntranceStepTransfers(userVisit, entities));
107        }
108
109        return result;
110    }
111    
112}