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