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.GetWorkflowEntrancesForm;
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.WorkflowLogic;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.model.data.workflow.server.entity.Workflow;
028import com.echothree.model.data.workflow.server.entity.WorkflowEntrance;
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 GetWorkflowEntrancesCommand
041        extends BasePaginatedMultipleEntitiesCommand<WorkflowEntrance, GetWorkflowEntrancesForm> {
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.List.name())
051                ))
052        ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, true, null, null)
056        );
057    }
058
059    /** Creates a new instance of GetWorkflowEntrancesCommand */
060    public GetWorkflowEntrancesCommand(UserVisitPK userVisitPK, GetWorkflowEntrancesForm form) {
061        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
062    }
063
064    Workflow workflow;
065
066    @Override
067    protected void handleForm() {
068        var workflowName = form.getWorkflowName();
069
070        workflow = WorkflowLogic.getInstance().getWorkflowByName(this, workflowName);
071    }
072
073    @Override
074    protected Long getTotalEntities() {
075        var workflowControl = Session.getModelController(WorkflowControl.class);
076
077        return hasExecutionErrors() ? null :
078                workflowControl.countWorkflowEntrancesByWorkflow(workflow);
079    }
080
081    @Override
082    protected Collection<WorkflowEntrance> getEntities() {
083        Collection<WorkflowEntrance> workflowEntrances = null;
084
085        if(!hasExecutionErrors()) {
086            var workflowControl = Session.getModelController(WorkflowControl.class);
087
088            workflowEntrances = workflowControl.getWorkflowEntrancesByWorkflow(workflow);
089        }
090
091        return workflowEntrances;
092    }
093
094    @Override
095    protected BaseResult getResult(Collection<WorkflowEntrance> entities) {
096        var result = WorkflowResultFactory.getGetWorkflowEntrancesResult();
097
098        if(entities != null) {
099            var workflowControl = Session.getModelController(WorkflowControl.class);
100            var userVisit = getUserVisit();
101
102            result.setWorkflow(workflowControl.getWorkflowTransfer(userVisit, workflow));
103            result.setWorkflowEntrances(workflowControl.getWorkflowEntranceTransfers(getUserVisit(), entities));
104        }
105
106        return result;
107    }
108
109}