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.message.server.command;
018
019import com.echothree.control.user.message.common.edit.MessageDescriptionEdit;
020import com.echothree.control.user.message.common.edit.MessageEditFactory;
021import com.echothree.control.user.message.common.form.EditMessageDescriptionForm;
022import com.echothree.control.user.message.common.result.MessageResultFactory;
023import com.echothree.control.user.message.common.spec.MessageDescriptionSpec;
024import com.echothree.model.control.message.server.control.MessageControl;
025import com.echothree.model.control.party.server.control.PartyControl;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.common.command.EditMode;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BaseEditCommand;
033import com.echothree.util.server.persistence.Session;
034import java.util.ArrayList;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037
038@Dependent
039public class EditMessageDescriptionCommand
040        extends BaseEditCommand<MessageDescriptionSpec, MessageDescriptionEdit> {
041    
042    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
043    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
044    
045    static {
046        SPEC_FIELD_DEFINITIONS = List.of(
047                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
048                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, true, null, null),
049                new FieldDefinition("MessageName", FieldType.ENTITY_NAME, true, null, null),
050                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
051                );
052        
053        EDIT_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
055                );
056    }
057    
058    /** Creates a new instance of EditMessageDescriptionCommand */
059    public EditMessageDescriptionCommand() {
060        super(null, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
061    }
062    
063    @Override
064    protected BaseResult execute() {
065        var result = MessageResultFactory.getEditMessageDescriptionResult();
066        var componentVendorName = spec.getComponentVendorName();
067        var componentVendor = componentControl.getComponentVendorByName(componentVendorName);
068        
069        if(componentVendor != null) {
070            var entityTypeName = spec.getEntityTypeName();
071            var entityType = entityTypeControl.getEntityTypeByName(componentVendor, entityTypeName);
072            
073            if(entityType != null) {
074                var messageControl = Session.getModelController(MessageControl.class);
075                var messageTypeName = spec.getMessageTypeName();
076                var messageType = messageControl.getMessageTypeByName(entityType, messageTypeName);
077                
078                if(messageType != null) {
079                    var messageName = spec.getMessageName();
080                    var message = messageControl.getMessageByName(messageType, messageName);
081                    
082                    if(message != null) {
083                        var partyControl = Session.getModelController(PartyControl.class);
084                        var languageIsoName = spec.getLanguageIsoName();
085                        var language = partyControl.getLanguageByIsoName(languageIsoName);
086                        
087                        if(language != null) {
088                            if(editMode.equals(EditMode.LOCK)) {
089                                var messageDescription = messageControl.getMessageDescription(message, language);
090                                
091                                if(messageDescription != null) {
092                                    result.setMessageDescription(messageControl.getMessageDescriptionTransfer(getUserVisit(), messageDescription));
093                                    
094                                    if(lockEntity(message)) {
095                                        var edit = MessageEditFactory.getMessageDescriptionEdit();
096                                        
097                                        result.setEdit(edit);
098                                        edit.setDescription(messageDescription.getDescription());
099                                    } else {
100                                        addExecutionError(ExecutionErrors.EntityLockFailed.name());
101                                    }
102                                    
103                                    result.setEntityLock(getEntityLockTransfer(message));
104                                } else {
105                                    addExecutionError(ExecutionErrors.UnknownMessageDescription.name());
106                                }
107                            } else if(editMode.equals(EditMode.UPDATE)) {
108                                var messageDescriptionValue = messageControl.getMessageDescriptionValueForUpdate(message, language);
109                                
110                                if(messageDescriptionValue != null) {
111                                    if(lockEntityForUpdate(message)) {
112                                        try {
113                                            var description = edit.getDescription();
114                                            
115                                            messageDescriptionValue.setDescription(description);
116                                            
117                                            messageControl.updateMessageDescriptionFromValue(messageDescriptionValue, getPartyPK());
118                                        } finally {
119                                            unlockEntity(message);
120                                        }
121                                    } else {
122                                        addExecutionError(ExecutionErrors.EntityLockStale.name());
123                                    }
124                                } else {
125                                    addExecutionError(ExecutionErrors.UnknownMessageDescription.name());
126                                }
127                            }
128                        } else {
129                            addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
130                        }
131                    } else {
132                        addExecutionError(ExecutionErrors.UnknownMessageName.name(), messageName);
133                    }
134                } else {
135                    addExecutionError(ExecutionErrors.UnknownMessageTypeName.name(), messageTypeName);
136                }
137            } else {
138                addExecutionError(ExecutionErrors.UnknownEntityTypeName.name(), entityTypeName);
139            }
140        } else {
141            addExecutionError(ExecutionErrors.UnknownComponentVendorName.name(), componentVendorName);
142        }
143        
144        return result;
145    }
146    
147}