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.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 java.util.List;
042import javax.enterprise.context.Dependent;
043import javax.inject.Inject;
044
045@Dependent
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    @Inject
078    WorkflowControl workflowControl;
079
080    @Inject
081    WorkflowStepLogic workflowStepLogic;
082
083    @Inject
084    WorkflowStepTypeLogic workflowStepTypeLogic;
085
086    
087    /** Creates a new instance of EditWorkflowStepCommand */
088    public EditWorkflowStepCommand() {
089        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
090    }
091
092    @Override
093    public EditWorkflowStepResult getResult() {
094        return WorkflowResultFactory.getEditWorkflowStepResult();
095    }
096
097    @Override
098    public WorkflowStepEdit getEdit() {
099        return WorkflowEditFactory.getWorkflowStepEdit();
100    }
101
102    @Override
103    public WorkflowStep getEntity(EditWorkflowStepResult result) {
104        return workflowStepLogic.getWorkflowStepByUniversalSpec(this, spec, false, editModeToEntityPermission(editMode));
105    }
106
107    @Override
108    public WorkflowStep getLockEntity(WorkflowStep freeOnBoard) {
109        return freeOnBoard;
110    }
111
112    @Override
113    public void fillInResult(EditWorkflowStepResult result, WorkflowStep freeOnBoard) {
114        var workflow = workflowControl;
115
116        result.setWorkflowStep(workflow.getWorkflowStepTransfer(getUserVisit(), freeOnBoard));
117    }
118
119    @Override
120    public void doLock(WorkflowStepEdit edit, WorkflowStep workflowStep) {
121        var workflowStepDescription = workflowControl.getWorkflowStepDescription(workflowStep, getPreferredLanguage());
122        var workflowStepDetail = workflowStep.getLastDetail();
123
124        edit.setWorkflowStepName(workflowStepDetail.getWorkflowStepName());
125        edit.setWorkflowStepTypeName(workflowStepDetail.getWorkflowStepType().getWorkflowStepTypeName());
126        edit.setIsDefault(workflowStepDetail.getIsDefault().toString());
127        edit.setSortOrder(workflowStepDetail.getSortOrder().toString());
128
129        if(workflowStepDescription != null) {
130            edit.setDescription(workflowStepDescription.getDescription());
131        }
132    }
133
134    WorkflowStepType workflowStepType;
135
136    @Override
137    public void canUpdate(WorkflowStep workflowStep) {
138        var workflow = workflowStep.getLastDetail().getWorkflow();
139        var workflowStepName = edit.getWorkflowStepName();
140        var duplicateWorkflowStep = workflowControl.getWorkflowStepByName(workflow, workflowStepName);
141
142        if(duplicateWorkflowStep != null && !workflowStep.equals(duplicateWorkflowStep)) {
143            addExecutionError(ExecutionErrors.DuplicateWorkflowStepName.name(), workflowStepName);
144        } else {
145            var workflowStepTypeName = edit.getWorkflowStepTypeName();
146
147            workflowStepType = workflowStepTypeLogic.getWorkflowStepTypeByName(this, workflowStepTypeName);
148        }
149    }
150
151    @Override
152    public void doUpdate(WorkflowStep workflowStep) {
153        var partyPK = getPartyPK();
154        var workflowStepDetailValue = workflowControl.getWorkflowStepDetailValueForUpdate(workflowStep);
155        var workflowStepDescription = workflowControl.getWorkflowStepDescriptionForUpdate(workflowStep, getPreferredLanguage());
156        var description = edit.getDescription();
157
158        workflowStepDetailValue.setWorkflowStepName(edit.getWorkflowStepName());
159        workflowStepDetailValue.setWorkflowStepTypePK(workflowStepType.getPrimaryKey());
160        workflowStepDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
161        workflowStepDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
162
163        workflowControl.updateWorkflowStepFromValue(workflowStepDetailValue, partyPK);
164
165        if(workflowStepDescription == null && description != null) {
166            workflowControl.createWorkflowStepDescription(workflowStep, getPreferredLanguage(), description, partyPK);
167        } else if(workflowStepDescription != null && description == null) {
168            workflowControl.deleteWorkflowStepDescription(workflowStepDescription, partyPK);
169        } else if(workflowStepDescription != null && description != null) {
170            var workflowStepDescriptionValue = workflowControl.getWorkflowStepDescriptionValue(workflowStepDescription);
171
172            workflowStepDescriptionValue.setDescription(description);
173            workflowControl.updateWorkflowStepDescriptionFromValue(workflowStepDescriptionValue, partyPK);
174        }
175    }
176    
177}