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.edit.WorkflowEditFactory;
020import com.echothree.control.user.workflow.common.edit.WorkflowStepEdit;
021import com.echothree.control.user.workflow.common.form.EditWorkflowStepForm;
022import com.echothree.control.user.workflow.common.result.EditWorkflowStepResult;
023import com.echothree.control.user.workflow.common.result.WorkflowResultFactory;
024import com.echothree.control.user.workflow.common.spec.WorkflowStepUniversalSpec;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.control.workflow.server.control.WorkflowControl;
029import com.echothree.model.control.workflow.server.logic.WorkflowStepLogic;
030import com.echothree.model.control.workflow.server.logic.WorkflowStepTypeLogic;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
032import com.echothree.model.data.workflow.server.entity.WorkflowStep;
033import com.echothree.model.data.workflow.server.entity.WorkflowStepType;
034import com.echothree.util.common.message.ExecutionErrors;
035import com.echothree.util.common.validation.FieldDefinition;
036import com.echothree.util.common.validation.FieldType;
037import com.echothree.util.server.control.BaseAbstractEditCommand;
038import com.echothree.util.server.control.CommandSecurityDefinition;
039import com.echothree.util.server.control.PartyTypeDefinition;
040import com.echothree.util.server.control.SecurityRoleDefinition;
041import com.echothree.util.server.persistence.Session;
042import java.util.List;
043import javax.enterprise.context.RequestScoped;
044
045@RequestScoped
046public class EditWorkflowStepCommand
047        extends BaseAbstractEditCommand<WorkflowStepUniversalSpec, WorkflowStepEdit, EditWorkflowStepResult, WorkflowStep, WorkflowStep> {
048
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
051    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
052    
053    static {
054        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
057                        new SecurityRoleDefinition(SecurityRoleGroups.WorkflowStep.name(), SecurityRoles.Edit.name())
058                ))
059        ));
060        
061        SPEC_FIELD_DEFINITIONS = List.of(
062                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, false, null, null),
063                new FieldDefinition("WorkflowStepName", FieldType.ENTITY_NAME, false, null, null),
064                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
065                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
066        );
067        
068        EDIT_FIELD_DEFINITIONS = List.of(
069                new FieldDefinition("WorkflowStepName", FieldType.ENTITY_NAME, true, null, null),
070                new FieldDefinition("WorkflowStepTypeName", FieldType.ENTITY_NAME, true, null, null),
071                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
072                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
073                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
074        );
075    }
076    
077    /** Creates a new instance of EditWorkflowStepCommand */
078    public EditWorkflowStepCommand() {
079        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
080    }
081
082    @Override
083    public EditWorkflowStepResult getResult() {
084        return WorkflowResultFactory.getEditWorkflowStepResult();
085    }
086
087    @Override
088    public WorkflowStepEdit getEdit() {
089        return WorkflowEditFactory.getWorkflowStepEdit();
090    }
091
092    @Override
093    public WorkflowStep getEntity(EditWorkflowStepResult result) {
094        return WorkflowStepLogic.getInstance().getWorkflowStepByUniversalSpec(this, spec, false, editModeToEntityPermission(editMode));
095    }
096
097    @Override
098    public WorkflowStep getLockEntity(WorkflowStep freeOnBoard) {
099        return freeOnBoard;
100    }
101
102    @Override
103    public void fillInResult(EditWorkflowStepResult result, WorkflowStep freeOnBoard) {
104        var workflow = Session.getModelController(WorkflowControl.class);
105
106        result.setWorkflowStep(workflow.getWorkflowStepTransfer(getUserVisit(), freeOnBoard));
107    }
108
109    @Override
110    public void doLock(WorkflowStepEdit edit, WorkflowStep workflowStep) {
111        var workflowControl = Session.getModelController(WorkflowControl.class);
112        var workflowStepDescription = workflowControl.getWorkflowStepDescription(workflowStep, getPreferredLanguage());
113        var workflowStepDetail = workflowStep.getLastDetail();
114
115        edit.setWorkflowStepName(workflowStepDetail.getWorkflowStepName());
116        edit.setWorkflowStepTypeName(workflowStepDetail.getWorkflowStepType().getWorkflowStepTypeName());
117        edit.setIsDefault(workflowStepDetail.getIsDefault().toString());
118        edit.setSortOrder(workflowStepDetail.getSortOrder().toString());
119
120        if(workflowStepDescription != null) {
121            edit.setDescription(workflowStepDescription.getDescription());
122        }
123    }
124
125    WorkflowStepType workflowStepType;
126
127    @Override
128    public void canUpdate(WorkflowStep workflowStep) {
129        var workflowControl = Session.getModelController(WorkflowControl.class);
130        var workflow = workflowStep.getLastDetail().getWorkflow();
131        var workflowStepName = edit.getWorkflowStepName();
132        var duplicateWorkflowStep = workflowControl.getWorkflowStepByName(workflow, workflowStepName);
133
134        if(duplicateWorkflowStep != null && !workflowStep.equals(duplicateWorkflowStep)) {
135            addExecutionError(ExecutionErrors.DuplicateWorkflowStepName.name(), workflowStepName);
136        } else {
137            var workflowStepTypeName = edit.getWorkflowStepTypeName();
138
139            workflowStepType = WorkflowStepTypeLogic.getInstance().getWorkflowStepTypeByName(this, workflowStepTypeName);
140        }
141    }
142
143    @Override
144    public void doUpdate(WorkflowStep workflowStep) {
145        var workflowControl = Session.getModelController(WorkflowControl.class);
146        var partyPK = getPartyPK();
147        var workflowStepDetailValue = workflowControl.getWorkflowStepDetailValueForUpdate(workflowStep);
148        var workflowStepDescription = workflowControl.getWorkflowStepDescriptionForUpdate(workflowStep, getPreferredLanguage());
149        var description = edit.getDescription();
150
151        workflowStepDetailValue.setWorkflowStepName(edit.getWorkflowStepName());
152        workflowStepDetailValue.setWorkflowStepTypePK(workflowStepType.getPrimaryKey());
153        workflowStepDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
154        workflowStepDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
155
156        workflowControl.updateWorkflowStepFromValue(workflowStepDetailValue, partyPK);
157
158        if(workflowStepDescription == null && description != null) {
159            workflowControl.createWorkflowStepDescription(workflowStep, getPreferredLanguage(), description, partyPK);
160        } else if(workflowStepDescription != null && description == null) {
161            workflowControl.deleteWorkflowStepDescription(workflowStepDescription, partyPK);
162        } else if(workflowStepDescription != null && description != null) {
163            var workflowStepDescriptionValue = workflowControl.getWorkflowStepDescriptionValue(workflowStepDescription);
164
165            workflowStepDescriptionValue.setDescription(description);
166            workflowControl.updateWorkflowStepDescriptionFromValue(workflowStepDescriptionValue, partyPK);
167        }
168    }
169    
170}