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