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.WorkflowDestinationDescriptionEdit;
020import com.echothree.control.user.workflow.common.edit.WorkflowEditFactory;
021import com.echothree.control.user.workflow.common.form.EditWorkflowDestinationDescriptionForm;
022import com.echothree.control.user.workflow.common.result.WorkflowResultFactory;
023import com.echothree.control.user.workflow.common.spec.WorkflowDestinationDescriptionSpec;
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 EditWorkflowDestinationDescriptionCommand
045        extends BaseEditCommand<WorkflowDestinationDescriptionSpec, WorkflowDestinationDescriptionEdit> {
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.WorkflowDestination.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("WorkflowStepName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("WorkflowDestinationName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
064                );
065        
066        EDIT_FIELD_DEFINITIONS = List.of(
067                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
068                );
069    }
070    
071    /** Creates a new instance of EditWorkflowDestinationDescriptionCommand */
072    public EditWorkflowDestinationDescriptionCommand() {
073        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
074    }
075    
076    @Override
077    protected BaseResult execute() {
078        var workflowControl = Session.getModelController(WorkflowControl.class);
079        var result = WorkflowResultFactory.getEditWorkflowDestinationDescriptionResult();
080        var workflowName = spec.getWorkflowName();
081        var workflow = workflowControl.getWorkflowByName(workflowName);
082        
083        if(workflow != null) {
084            var workflowStepName = spec.getWorkflowStepName();
085            var workflowStep = workflowControl.getWorkflowStepByName(workflow, workflowStepName);
086            
087            if(workflowStep != null) {
088                var workflowDestinationName = spec.getWorkflowDestinationName();
089                var workflowDestination = workflowControl.getWorkflowDestinationByName(workflowStep, workflowDestinationName);
090                
091                if(workflowDestination != null) {
092                    var partyControl = Session.getModelController(PartyControl.class);
093                    var languageIsoName = spec.getLanguageIsoName();
094                    var language = partyControl.getLanguageByIsoName(languageIsoName);
095                    
096                    if(language != null) {
097                        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
098                            var workflowDestinationDescription = workflowControl.getWorkflowDestinationDescription(workflowDestination, language);
099                            
100                            if(workflowDestinationDescription != null) {
101                                if(editMode.equals(EditMode.LOCK)) {
102                                    result.setWorkflowDestinationDescription(workflowControl.getWorkflowDestinationDescriptionTransfer(getUserVisit(), workflowDestinationDescription));
103
104                                    if(lockEntity(workflowDestination)) {
105                                        var edit = WorkflowEditFactory.getWorkflowDestinationDescriptionEdit();
106
107                                        result.setEdit(edit);
108                                        edit.setDescription(workflowDestinationDescription.getDescription());
109                                    } else {
110                                        addExecutionError(ExecutionErrors.EntityLockFailed.name());
111                                    }
112
113                                    result.setEntityLock(getEntityLockTransfer(workflowDestination));
114                                } else { // EditMode.ABANDON
115                                    unlockEntity(workflowDestination);
116                                }
117                            } else {
118                                addExecutionError(ExecutionErrors.UnknownWorkflowDestinationDescription.name());
119                            }
120                        } else if(editMode.equals(EditMode.UPDATE)) {
121                            var workflowDestinationDescriptionValue = workflowControl.getWorkflowDestinationDescriptionValueForUpdate(workflowDestination, language);
122                            
123                            if(workflowDestinationDescriptionValue != null) {
124                                if(lockEntityForUpdate(workflowDestination)) {
125                                    try {
126                                        var description = edit.getDescription();
127                                        
128                                        workflowDestinationDescriptionValue.setDescription(description);
129                                        
130                                        workflowControl.updateWorkflowDestinationDescriptionFromValue(workflowDestinationDescriptionValue, getPartyPK());
131                                    } finally {
132                                        unlockEntity(workflowDestination);
133                                    }
134                                } else {
135                                    addExecutionError(ExecutionErrors.EntityLockStale.name());
136                                }
137                            } else {
138                                addExecutionError(ExecutionErrors.UnknownWorkflowDestinationDescription.name());
139                            }
140                        }
141                    } else {
142                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
143                    }
144                } else {
145                    addExecutionError(ExecutionErrors.UnknownWorkflowDestinationName.name(), workflowDestinationName);
146                }
147            } else {
148                addExecutionError(ExecutionErrors.UnknownWorkflowStepName.name(), workflowStepName);
149            }
150        } else {
151            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
152        }
153        
154        return result;
155    }
156    
157}