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.letter.server.command;
018
019import com.echothree.control.user.letter.common.edit.LetterDescriptionEdit;
020import com.echothree.control.user.letter.common.edit.LetterEditFactory;
021import com.echothree.control.user.letter.common.form.EditLetterDescriptionForm;
022import com.echothree.control.user.letter.common.result.LetterResultFactory;
023import com.echothree.control.user.letter.common.spec.LetterDescriptionSpec;
024import com.echothree.model.control.chain.server.control.ChainControl;
025import com.echothree.model.control.letter.server.control.LetterControl;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.party.server.control.PartyControl;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.BaseResult;
035import com.echothree.util.common.command.EditMode;
036import com.echothree.util.server.control.BaseEditCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import java.util.List;
041import javax.enterprise.context.Dependent;
042import javax.inject.Inject;
043
044@Dependent
045public class EditLetterDescriptionCommand
046        extends BaseEditCommand<LetterDescriptionSpec, LetterDescriptionEdit> {
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.Letter.name(), SecurityRoles.Description.name())
057                ))
058        ));
059        
060        SPEC_FIELD_DEFINITIONS = List.of(
061                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("LetterName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
065        );
066        
067        EDIT_FIELD_DEFINITIONS = List.of(
068                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
069        );
070    }
071
072    @Inject
073    ChainControl chainControl;
074
075    @Inject
076    LetterControl letterControl;
077
078    @Inject
079    PartyControl partyControl;
080
081    
082    /** Creates a new instance of EditLetterDescriptionCommand */
083    public EditLetterDescriptionCommand() {
084        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
085    }
086    
087    @Override
088    protected BaseResult execute() {
089        var result = LetterResultFactory.getEditLetterDescriptionResult();
090        var chainKindName = spec.getChainKindName();
091        var chainKind = chainControl.getChainKindByName(chainKindName);
092        
093        if(chainKind != null) {
094            var chainTypeName = spec.getChainTypeName();
095            var chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
096            
097            if(chainType != null) {
098                var letterName = spec.getLetterName();
099                var letter = letterControl.getLetterByName(chainType, letterName);
100                
101                if(letter != null) {
102                    var languageIsoName = spec.getLanguageIsoName();
103                    var language = partyControl.getLanguageByIsoName(languageIsoName);
104                    
105                    if(language != null) {
106                        if(editMode.equals(EditMode.LOCK)) {
107                            var letterDescription = letterControl.getLetterDescription(letter, language);
108                            
109                            if(letterDescription != null) {
110                                result.setLetterDescription(letterControl.getLetterDescriptionTransfer(getUserVisit(), letterDescription));
111                                
112                                if(lockEntity(letter)) {
113                                    var edit = LetterEditFactory.getLetterDescriptionEdit();
114                                    
115                                    result.setEdit(edit);
116                                    edit.setDescription(letterDescription.getDescription());
117                                } else {
118                                    addExecutionError(ExecutionErrors.EntityLockFailed.name());
119                                }
120                                
121                                result.setEntityLock(getEntityLockTransfer(letter));
122                            } else {
123                                addExecutionError(ExecutionErrors.UnknownLetterDescription.name());
124                            }
125                        } else if(editMode.equals(EditMode.UPDATE)) {
126                            var letterDescriptionValue = letterControl.getLetterDescriptionValueForUpdate(letter, language);
127                            
128                            if(letterDescriptionValue != null) {
129                                if(lockEntityForUpdate(letter)) {
130                                    try {
131                                        var description = edit.getDescription();
132                                        
133                                        letterDescriptionValue.setDescription(description);
134                                        
135                                        letterControl.updateLetterDescriptionFromValue(letterDescriptionValue, getPartyPK());
136                                    } finally {
137                                        unlockEntity(letter);
138                                    }
139                                } else {
140                                    addExecutionError(ExecutionErrors.EntityLockStale.name());
141                                }
142                            } else {
143                                addExecutionError(ExecutionErrors.UnknownLetterDescription.name());
144                            }
145                        }
146                    } else {
147                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
148                    }
149                } else {
150                    addExecutionError(ExecutionErrors.UnknownLetterName.name(), letterName);
151                }
152            } else {
153                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainTypeName);
154            }
155        } else {
156            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
157        }
158        
159        return result;
160    }
161    
162}