001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.GetWorkflowEntityStatusesForm;
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.WorkflowEntityStatus;
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;
039import javax.enterprise.context.RequestScoped;
040
041@RequestScoped
042public class GetWorkflowEntityStatusesCommand
043        extends BasePaginatedMultipleEntitiesCommand<WorkflowEntityStatus, GetWorkflowEntityStatusesForm> {
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(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.WorkflowEntityStatus.name(), SecurityRoles.List.name())
053                ))
054        ));
055
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, true, null, null)
058        );
059    }
060    
061    /** Creates a new instance of GetWorkflowEntityStatusesCommand */
062    public GetWorkflowEntityStatusesCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
064    }
065
066    Workflow workflow;
067
068    @Override
069    protected void handleForm() {
070        var workflowName = form.getWorkflowName();
071
072        workflow = WorkflowLogic.getInstance().getWorkflowByName(this, workflowName);
073    }
074
075    @Override
076    protected Long getTotalEntities() {
077        var workflowControl = Session.getModelController(WorkflowControl.class);
078
079        return hasExecutionErrors() ? null :
080                workflowControl.countWorkflowEntityStatusesByWorkflow(workflow);
081    }
082
083    @Override
084    protected Collection<WorkflowEntityStatus> getEntities() {
085        Collection<WorkflowEntityStatus> workflowEntityStatuses = null;
086
087        if(!hasExecutionErrors()) {
088            var workflowControl = Session.getModelController(WorkflowControl.class);
089
090            workflowEntityStatuses = workflowControl.getWorkflowEntityStatusesByWorkflow(workflow);
091        }
092
093        return workflowEntityStatuses;
094    }
095
096    @Override
097    protected BaseResult getResult(Collection<WorkflowEntityStatus> entities) {
098        var result = WorkflowResultFactory.getGetWorkflowEntityStatusesResult();
099
100        if(entities != null) {
101            var workflowControl = Session.getModelController(WorkflowControl.class);
102            var userVisit = getUserVisit();
103
104            result.setWorkflow(workflowControl.getWorkflowTransfer(userVisit, workflow));
105            result.setWorkflowEntityStatuses(workflowControl.getWorkflowEntityStatusTransfers(getUserVisit(), entities));
106        }
107
108        return result;
109    }
110
111}