001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.EditLetterDescriptionResult;
023import com.echothree.control.user.letter.common.result.LetterResultFactory;
024import com.echothree.control.user.letter.common.spec.LetterDescriptionSpec;
025import com.echothree.model.control.chain.server.control.ChainControl;
026import com.echothree.model.control.letter.server.control.LetterControl;
027import com.echothree.model.control.party.common.PartyTypes;
028import com.echothree.model.control.party.server.control.PartyControl;
029import com.echothree.model.control.security.common.SecurityRoleGroups;
030import com.echothree.model.control.security.common.SecurityRoles;
031import com.echothree.model.data.chain.server.entity.ChainKind;
032import com.echothree.model.data.chain.server.entity.ChainType;
033import com.echothree.model.data.letter.server.entity.Letter;
034import com.echothree.model.data.letter.server.entity.LetterDescription;
035import com.echothree.model.data.letter.server.value.LetterDescriptionValue;
036import com.echothree.model.data.party.server.entity.Language;
037import com.echothree.model.data.user.common.pk.UserVisitPK;
038import com.echothree.util.common.message.ExecutionErrors;
039import com.echothree.util.common.validation.FieldDefinition;
040import com.echothree.util.common.validation.FieldType;
041import com.echothree.util.common.command.BaseResult;
042import com.echothree.util.common.command.EditMode;
043import com.echothree.util.server.control.BaseEditCommand;
044import com.echothree.util.server.control.CommandSecurityDefinition;
045import com.echothree.util.server.control.PartyTypeDefinition;
046import com.echothree.util.server.control.SecurityRoleDefinition;
047import com.echothree.util.server.persistence.Session;
048import java.util.Arrays;
049import java.util.Collections;
050import java.util.List;
051
052public class EditLetterDescriptionCommand
053        extends BaseEditCommand<LetterDescriptionSpec, LetterDescriptionEdit> {
054    
055    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
056    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
057    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
058    
059    static {
060        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
061                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
062                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
063                        new SecurityRoleDefinition(SecurityRoleGroups.Letter.name(), SecurityRoles.Description.name())
064                        )))
065                )));
066        
067        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
068                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
069                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
070                new FieldDefinition("LetterName", FieldType.ENTITY_NAME, true, null, null),
071                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
072                ));
073        
074        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
075                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
076                ));
077    }
078    
079    /** Creates a new instance of EditLetterDescriptionCommand */
080    public EditLetterDescriptionCommand(UserVisitPK userVisitPK, EditLetterDescriptionForm form) {
081        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
082    }
083    
084    @Override
085    protected BaseResult execute() {
086        var chainControl = Session.getModelController(ChainControl.class);
087        EditLetterDescriptionResult result = LetterResultFactory.getEditLetterDescriptionResult();
088        String chainKindName = spec.getChainKindName();
089        ChainKind chainKind = chainControl.getChainKindByName(chainKindName);
090        
091        if(chainKind != null) {
092            String chainTypeName = spec.getChainTypeName();
093            ChainType chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
094            
095            if(chainType != null) {
096                var letterControl = Session.getModelController(LetterControl.class);
097                String letterName = spec.getLetterName();
098                Letter letter = letterControl.getLetterByName(chainType, letterName);
099                
100                if(letter != null) {
101                    var partyControl = Session.getModelController(PartyControl.class);
102                    String languageIsoName = spec.getLanguageIsoName();
103                    Language language = partyControl.getLanguageByIsoName(languageIsoName);
104                    
105                    if(language != null) {
106                        if(editMode.equals(EditMode.LOCK)) {
107                            LetterDescription letterDescription = letterControl.getLetterDescription(letter, language);
108                            
109                            if(letterDescription != null) {
110                                result.setLetterDescription(letterControl.getLetterDescriptionTransfer(getUserVisit(), letterDescription));
111                                
112                                if(lockEntity(letter)) {
113                                    LetterDescriptionEdit 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                            LetterDescriptionValue letterDescriptionValue = letterControl.getLetterDescriptionValueForUpdate(letter, language);
127                            
128                            if(letterDescriptionValue != null) {
129                                if(lockEntityForUpdate(letter)) {
130                                    try {
131                                        String 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}