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.GetWorkflowDestinationSecurityRolesForm;
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.WorkflowDestinationPartyType;
028import com.echothree.model.data.workflow.server.entity.WorkflowDestinationSecurityRole;
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 GetWorkflowDestinationSecurityRolesCommand
043        extends BasePaginatedMultipleEntitiesCommand<WorkflowDestinationSecurityRole, GetWorkflowDestinationSecurityRolesForm> {
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.WorkflowDestination.name(), SecurityRoles.SecurityRole.name())
053                ))
054        ));
055
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("WorkflowStepName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("WorkflowDestinationName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("PartyTypeName", FieldType.ENTITY_NAME, true, null, null)
061        );
062    }
063    
064    /** Creates a new instance of GetWorkflowDestinationSecurityRolesCommand */
065    public GetWorkflowDestinationSecurityRolesCommand() {
066        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
067    }
068    
069    WorkflowDestinationPartyType workflowDestinationPartyType;
070
071    @Override
072    protected void handleForm() {
073        var workflowName = form.getWorkflowName();
074        var workflowStepName = form.getWorkflowStepName();
075        var workflowDestinationName = form.getWorkflowDestinationName();
076        var partyTypeName = form.getPartyTypeName();
077
078        workflowDestinationPartyType = WorkflowDestinationLogic.getInstance().getWorkflowDestinationPartyTypeByName(this, workflowName,
079                workflowStepName, workflowDestinationName, partyTypeName);
080    }
081
082    @Override
083    protected Long getTotalEntities() {
084        var workflowControl = Session.getModelController(WorkflowControl.class);
085
086        return hasExecutionErrors() ? null :
087                workflowControl.countWorkflowDestinationSecurityRolesByWorkflowDestinationPartyType(workflowDestinationPartyType);
088    }
089
090    @Override
091    protected Collection<WorkflowDestinationSecurityRole> getEntities() {
092        Collection<WorkflowDestinationSecurityRole> workflowDestinationSecurityRoles = null;
093
094        if(!hasExecutionErrors()) {
095            var workflowControl = Session.getModelController(WorkflowControl.class);
096
097            workflowDestinationSecurityRoles = workflowControl.getWorkflowDestinationSecurityRolesByWorkflowDestinationPartyType(workflowDestinationPartyType);
098        }
099
100        return workflowDestinationSecurityRoles;
101    }
102
103    @Override
104    protected BaseResult getResult(Collection<WorkflowDestinationSecurityRole> entities) {
105        var result = WorkflowResultFactory.getGetWorkflowDestinationSecurityRolesResult();
106
107        if(entities != null) {
108            var workflowControl = Session.getModelController(WorkflowControl.class);
109            var userVisit = getUserVisit();
110
111            result.setWorkflowDestinationPartyType(workflowControl.getWorkflowDestinationPartyTypeTransfer(userVisit, workflowDestinationPartyType));
112            result.setWorkflowDestinationSecurityRoles(workflowControl.getWorkflowDestinationSecurityRoleTransfers(userVisit, entities));
113        }
114
115        return result;
116    }
117
118}