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.WorkflowDescriptionEdit;
020import com.echothree.control.user.workflow.common.edit.WorkflowEditFactory;
021import com.echothree.control.user.workflow.common.form.EditWorkflowDescriptionForm;
022import com.echothree.control.user.workflow.common.result.WorkflowResultFactory;
023import com.echothree.control.user.workflow.common.spec.WorkflowDescriptionSpec;
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.List;
041import javax.enterprise.context.Dependent;
042
043@Dependent
044public class EditWorkflowDescriptionCommand
045        extends BaseEditCommand<WorkflowDescriptionSpec, WorkflowDescriptionEdit> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
049    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.Workflow.name(), SecurityRoles.Description.name())
056                        ))
057                ));
058        
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
062                );
063        
064        EDIT_FIELD_DEFINITIONS = List.of(
065                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
066                );
067    }
068    
069    /** Creates a new instance of EditWorkflowDescriptionCommand */
070    public EditWorkflowDescriptionCommand() {
071        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
072    }
073    
074    @Override
075    protected BaseResult execute() {
076        var workflowControl = Session.getModelController(WorkflowControl.class);
077        var result = WorkflowResultFactory.getEditWorkflowDescriptionResult();
078        var workflowName = spec.getWorkflowName();
079        var workflow = workflowControl.getWorkflowByName(workflowName);
080        
081        if(workflow != null) {
082            var partyControl = Session.getModelController(PartyControl.class);
083            var languageIsoName = spec.getLanguageIsoName();
084            var language = partyControl.getLanguageByIsoName(languageIsoName);
085            
086            if(language != null) {
087                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
088                    var workflowDescription = workflowControl.getWorkflowDescription(workflow, language);
089                    
090                    if(workflowDescription != null) {
091                        if(editMode.equals(EditMode.LOCK)) {
092                            result.setWorkflowDescription(workflowControl.getWorkflowDescriptionTransfer(getUserVisit(), workflowDescription));
093
094                            if(lockEntity(workflow)) {
095                                var edit = WorkflowEditFactory.getWorkflowDescriptionEdit();
096
097                                result.setEdit(edit);
098                                edit.setDescription(workflowDescription.getDescription());
099                            } else {
100                                addExecutionError(ExecutionErrors.EntityLockFailed.name());
101                            }
102
103                            result.setEntityLock(getEntityLockTransfer(workflow));
104                        } else { // EditMode.ABANDON
105                            unlockEntity(workflow);
106                        }
107                    } else {
108                        addExecutionError(ExecutionErrors.UnknownWorkflowDescription.name());
109                    }
110                } else if(editMode.equals(EditMode.UPDATE)) {
111                    var workflowDescriptionValue = workflowControl.getWorkflowDescriptionValueForUpdate(workflow, language);
112                    
113                    if(workflowDescriptionValue != null) {
114                        if(lockEntityForUpdate(workflow)) {
115                            try {
116                                var description = edit.getDescription();
117                                
118                                workflowDescriptionValue.setDescription(description);
119                                
120                                workflowControl.updateWorkflowDescriptionFromValue(workflowDescriptionValue, getPartyPK());
121                            } finally {
122                                unlockEntity(workflow);
123                            }
124                        } else {
125                            addExecutionError(ExecutionErrors.EntityLockStale.name());
126                        }
127                    } else {
128                        addExecutionError(ExecutionErrors.UnknownWorkflowDescription.name());
129                    }
130                }
131            } else {
132                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
133            }
134        } else {
135            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
136        }
137        
138        return result;
139    }
140    
141}