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.WorkflowStepDescriptionEdit;
021import com.echothree.control.user.workflow.common.form.EditWorkflowStepDescriptionForm;
022import com.echothree.control.user.workflow.common.result.WorkflowResultFactory;
023import com.echothree.control.user.workflow.common.spec.WorkflowStepDescriptionSpec;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.party.server.control.PartyControl;
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.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.common.command.BaseResult;
034import com.echothree.util.common.command.EditMode;
035import com.echothree.util.server.control.BaseEditCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.Arrays;
041import java.util.Collections;
042import java.util.List;
043import javax.enterprise.context.RequestScoped;
044
045@RequestScoped
046public class EditWorkflowStepDescriptionCommand
047        extends BaseEditCommand<WorkflowStepDescriptionSpec, WorkflowStepDescriptionEdit> {
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(Collections.unmodifiableList(Arrays.asList(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
057                        new SecurityRoleDefinition(SecurityRoleGroups.WorkflowStep.name(), SecurityRoles.Description.name())
058                        )))
059                )));
060        
061        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
062                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("WorkflowStepName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
065                ));
066        
067        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
068                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
069                ));
070    }
071    
072    /** Creates a new instance of EditWorkflowStepDescriptionCommand */
073    public EditWorkflowStepDescriptionCommand() {
074        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
075    }
076    
077    @Override
078    protected BaseResult execute() {
079        var workflowControl = Session.getModelController(WorkflowControl.class);
080        var result = WorkflowResultFactory.getEditWorkflowStepDescriptionResult();
081        var workflowName = spec.getWorkflowName();
082        var workflow = workflowControl.getWorkflowByName(workflowName);
083        
084        if(workflow != null) {
085            var workflowStepName = spec.getWorkflowStepName();
086            var workflowStep = workflowControl.getWorkflowStepByName(workflow, workflowStepName);
087            
088            if(workflowStep != null) {
089                var partyControl = Session.getModelController(PartyControl.class);
090                var languageIsoName = spec.getLanguageIsoName();
091                var language = partyControl.getLanguageByIsoName(languageIsoName);
092                
093                if(language != null) {
094                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
095                        var workflowStepDescription = workflowControl.getWorkflowStepDescription(workflowStep, language);
096                        
097                        if(workflowStepDescription != null) {
098                            if(editMode.equals(EditMode.LOCK)) {
099                                result.setWorkflowStepDescription(workflowControl.getWorkflowStepDescriptionTransfer(getUserVisit(), workflowStepDescription));
100
101                                if(lockEntity(workflowStep)) {
102                                    var edit = WorkflowEditFactory.getWorkflowStepDescriptionEdit();
103
104                                    result.setEdit(edit);
105                                    edit.setDescription(workflowStepDescription.getDescription());
106                                } else {
107                                    addExecutionError(ExecutionErrors.EntityLockFailed.name());
108                                }
109
110                                result.setEntityLock(getEntityLockTransfer(workflowStep));
111                            } else { // EditMode.ABANDON
112                                unlockEntity(workflowStep);
113                            }
114                        } else {
115                            addExecutionError(ExecutionErrors.UnknownWorkflowStepDescription.name());
116                        }
117                    } else if(editMode.equals(EditMode.UPDATE)) {
118                        var workflowStepDescriptionValue = workflowControl.getWorkflowStepDescriptionValueForUpdate(workflowStep, language);
119                        
120                        if(workflowStepDescriptionValue != null) {
121                            if(lockEntityForUpdate(workflowStep)) {
122                                try {
123                                    var description = edit.getDescription();
124                                    
125                                    workflowStepDescriptionValue.setDescription(description);
126                                    
127                                    workflowControl.updateWorkflowStepDescriptionFromValue(workflowStepDescriptionValue, getPartyPK());
128                                } finally {
129                                    unlockEntity(workflowStep);
130                                }
131                            } else {
132                                addExecutionError(ExecutionErrors.EntityLockStale.name());
133                            }
134                        } else {
135                            addExecutionError(ExecutionErrors.UnknownWorkflowStepDescription.name());
136                        }
137                    }
138                } else {
139                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
140                }
141            } else {
142                addExecutionError(ExecutionErrors.UnknownWorkflowStepName.name(), workflowStepName);
143            }
144        } else {
145            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
146        }
147        
148        return result;
149    }
150    
151}