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.LetterEditFactory;
020import com.echothree.control.user.letter.common.edit.LetterSourceDescriptionEdit;
021import com.echothree.control.user.letter.common.form.EditLetterSourceDescriptionForm;
022import com.echothree.control.user.letter.common.result.LetterResultFactory;
023import com.echothree.control.user.letter.common.spec.LetterSourceDescriptionSpec;
024import com.echothree.model.control.letter.server.control.LetterControl;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.party.server.control.PartyControl;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
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 EditLetterSourceDescriptionCommand
045        extends BaseEditCommand<LetterSourceDescriptionSpec, LetterSourceDescriptionEdit> {
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.LetterSource.name(), SecurityRoles.Description.name())
056                        ))
057                ));
058        
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("LetterSourceName", 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 EditLetterSourceDescriptionCommand */
070    public EditLetterSourceDescriptionCommand() {
071        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
072    }
073    
074    @Override
075    protected BaseResult execute() {
076        var letterControl = Session.getModelController(LetterControl.class);
077        var result = LetterResultFactory.getEditLetterSourceDescriptionResult();
078        var letterSourceName = spec.getLetterSourceName();
079        var letterSource = letterControl.getLetterSourceByName(letterSourceName);
080        
081        if(letterSource != 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)) {
088                    var letterSourceDescription = letterControl.getLetterSourceDescription(letterSource, language);
089                    
090                    if(letterSourceDescription != null) {
091                        result.setLetterSourceDescription(letterControl.getLetterSourceDescriptionTransfer(getUserVisit(), letterSourceDescription));
092                        
093                        if(lockEntity(letterSource)) {
094                            var edit = LetterEditFactory.getLetterSourceDescriptionEdit();
095                            
096                            result.setEdit(edit);
097                            edit.setDescription(letterSourceDescription.getDescription());
098                        } else {
099                            addExecutionError(ExecutionErrors.EntityLockFailed.name());
100                        }
101                        
102                        result.setEntityLock(getEntityLockTransfer(letterSource));
103                    } else {
104                        addExecutionError(ExecutionErrors.UnknownLetterSourceDescription.name());
105                    }
106                } else if(editMode.equals(EditMode.UPDATE)) {
107                    var letterSourceDescriptionValue = letterControl.getLetterSourceDescriptionValueForUpdate(letterSource, language);
108                    
109                    if(letterSourceDescriptionValue != null) {
110                        if(lockEntityForUpdate(letterSource)) {
111                            try {
112                                var description = edit.getDescription();
113                                
114                                letterSourceDescriptionValue.setDescription(description);
115                                
116                                letterControl.updateLetterSourceDescriptionFromValue(letterSourceDescriptionValue, getPartyPK());
117                            } finally {
118                                unlockEntity(letterSource);
119                            }
120                        } else {
121                            addExecutionError(ExecutionErrors.EntityLockStale.name());
122                        }
123                    } else {
124                        addExecutionError(ExecutionErrors.UnknownLetterSourceDescription.name());
125                    }
126                }
127            } else {
128                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
129            }
130        } else {
131            addExecutionError(ExecutionErrors.UnknownLetterSourceName.name(), letterSourceName);
132        }
133        
134        return result;
135    }
136    
137}