001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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 java.util.Collection;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
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    @Inject
065    WorkflowControl workflowControl;
066
067    @Inject
068    WorkflowDestinationLogic workflowDestinationLogic;
069
070    
071    /** Creates a new instance of GetWorkflowDestinationSecurityRolesCommand */
072    public GetWorkflowDestinationSecurityRolesCommand() {
073        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
074    }
075    
076    WorkflowDestinationPartyType workflowDestinationPartyType;
077
078    @Override
079    protected void handleForm() {
080        var workflowName = form.getWorkflowName();
081        var workflowStepName = form.getWorkflowStepName();
082        var workflowDestinationName = form.getWorkflowDestinationName();
083        var partyTypeName = form.getPartyTypeName();
084
085        workflowDestinationPartyType = workflowDestinationLogic.getWorkflowDestinationPartyTypeByName(this, workflowName,
086                workflowStepName, workflowDestinationName, partyTypeName);
087    }
088
089    @Override
090    protected Long getTotalEntities() {
091        return hasExecutionErrors() ? null :
092                workflowControl.countWorkflowDestinationSecurityRolesByWorkflowDestinationPartyType(workflowDestinationPartyType);
093    }
094
095    @Override
096    protected Collection<WorkflowDestinationSecurityRole> getEntities() {
097        Collection<WorkflowDestinationSecurityRole> workflowDestinationSecurityRoles = null;
098
099        if(!hasExecutionErrors()) {
100            workflowDestinationSecurityRoles = workflowControl.getWorkflowDestinationSecurityRolesByWorkflowDestinationPartyType(workflowDestinationPartyType);
101        }
102
103        return workflowDestinationSecurityRoles;
104    }
105
106    @Override
107    protected BaseResult getResult(Collection<WorkflowDestinationSecurityRole> entities) {
108        var result = WorkflowResultFactory.getGetWorkflowDestinationSecurityRolesResult();
109
110        if(entities != null) {
111            var userVisit = getUserVisit();
112
113            result.setWorkflowDestinationPartyType(workflowControl.getWorkflowDestinationPartyTypeTransfer(userVisit, workflowDestinationPartyType));
114            result.setWorkflowDestinationSecurityRoles(workflowControl.getWorkflowDestinationSecurityRoleTransfers(userVisit, entities));
115        }
116
117        return result;
118    }
119
120}