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.LetterSourceEdit;
021import com.echothree.control.user.letter.common.form.EditLetterSourceForm;
022import com.echothree.control.user.letter.common.result.LetterResultFactory;
023import com.echothree.control.user.letter.common.spec.LetterSourceSpec;
024import com.echothree.model.control.contact.server.control.ContactControl;
025import com.echothree.model.control.letter.server.control.LetterControl;
026import com.echothree.model.control.party.common.PartyTypes;
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 EditLetterSourceCommand
045        extends BaseEditCommand<LetterSourceSpec, LetterSourceEdit> {
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.Edit.name())
056                    ))
057                ));
058        
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("LetterSourceName", FieldType.ENTITY_NAME, true, null, null)
061                );
062        
063        EDIT_FIELD_DEFINITIONS = List.of(
064                new FieldDefinition("LetterSourceName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("EmailAddressContactMechanismName", FieldType.ENTITY_NAME, false, null, null),
066                new FieldDefinition("EmailAddressContactMechanismAliasTypeName", FieldType.ENTITY_NAME, false, null, null),
067                new FieldDefinition("EmailAddressContactMechanismAlias", FieldType.ENTITY_NAME, false, null, null),
068                new FieldDefinition("PostalAddressContactMechanismName", FieldType.ENTITY_NAME, false, null, null),
069                new FieldDefinition("PostalAddressContactMechanismAliasTypeName", FieldType.ENTITY_NAME, false, null, null),
070                new FieldDefinition("PostalAddressContactMechanismAlias", FieldType.ENTITY_NAME, false, null, null),
071                new FieldDefinition("LetterSourceContactMechanismName", FieldType.ENTITY_NAME, false, null, null),
072                new FieldDefinition("LetterSourceContactMechanismAliasTypeName", FieldType.ENTITY_NAME, false, null, null),
073                new FieldDefinition("LetterSourceContactMechanismAlias", FieldType.ENTITY_NAME, false, null, null),
074                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
075                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
076                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
077                );
078    }
079    
080    /** Creates a new instance of EditLetterSourceCommand */
081    public EditLetterSourceCommand() {
082        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
083    }
084    
085    @Override
086    protected BaseResult execute() {
087        var letterControl = Session.getModelController(LetterControl.class);
088        var result = LetterResultFactory.getEditLetterSourceResult();
089        
090        if(editMode.equals(EditMode.LOCK)) {
091            var letterSourceName = spec.getLetterSourceName();
092            var letterSource = letterControl.getLetterSourceByName(letterSourceName);
093            
094            if(letterSource != null) {
095                result.setLetterSource(letterControl.getLetterSourceTransfer(getUserVisit(), letterSource));
096                
097                if(lockEntity(letterSource)) {
098                    var letterSourceDescription = letterControl.getLetterSourceDescription(letterSource, getPreferredLanguage());
099                    var edit = LetterEditFactory.getLetterSourceEdit();
100                    var letterSourceDetail = letterSource.getLastDetail();
101                    
102                    result.setEdit(edit);
103                    edit.setLetterSourceName(letterSourceDetail.getLetterSourceName());
104                    edit.setEmailAddressContactMechanismName(letterSourceDetail.getEmailAddressPartyContactMechanism().getLastDetail().getContactMechanism().getLastDetail().getContactMechanismName());
105                    edit.setPostalAddressContactMechanismName(letterSourceDetail.getPostalAddressPartyContactMechanism().getLastDetail().getContactMechanism().getLastDetail().getContactMechanismName());
106                    edit.setLetterSourceContactMechanismName(letterSourceDetail.getLetterSourcePartyContactMechanism().getLastDetail().getContactMechanism().getLastDetail().getContactMechanismName());
107                    edit.setIsDefault(letterSourceDetail.getIsDefault().toString());
108                    edit.setSortOrder(letterSourceDetail.getSortOrder().toString());
109                    
110                    if(letterSourceDescription != null)
111                        edit.setDescription(letterSourceDescription.getDescription());
112                } else {
113                    addExecutionError(ExecutionErrors.EntityLockFailed.name());
114                }
115                
116                result.setEntityLock(getEntityLockTransfer(letterSource));
117            } else {
118                addExecutionError(ExecutionErrors.UnknownLetterSourceName.name(), letterSourceName);
119            }
120        } else if(editMode.equals(EditMode.UPDATE)) {
121            var letterSourceName = spec.getLetterSourceName();
122            var letterSource = letterControl.getLetterSourceByNameForUpdate(letterSourceName);
123            
124            if(letterSource != null) {
125                letterSourceName = edit.getLetterSourceName();
126                var duplicateLetterSource = letterControl.getLetterSourceByName(letterSourceName);
127                
128                if(duplicateLetterSource == null || letterSource.equals(duplicateLetterSource)) {
129                    var contactControl = Session.getModelController(ContactControl.class);
130                    var companyParty = letterSource.getLastDetail().getCompanyParty();
131                    var letterSourceCommandUtil = LetterSourceCommandUtil.getInstance();
132                    var emailAddressPartyContactMechanism = letterSourceCommandUtil.getEmailAddressContactMechanism(this, edit, contactControl,
133                            companyParty);
134                    
135                    if(!hasExecutionErrors()) {
136                        var postalAddressPartyContactMechanism = letterSourceCommandUtil.getPostalAddressContactMechanism(this, edit,
137                                contactControl, companyParty);
138                        
139                        if(!hasExecutionErrors()) {
140                            var letterSourcePartyContactMechanism = letterSourceCommandUtil.getLetterSourceContactMechanism(this, edit,
141                                    contactControl, companyParty);
142                            
143                            if(!hasExecutionErrors()) {
144                                if(lockEntityForUpdate(letterSource)) {
145                                    try {
146                                        var partyPK = getPartyPK();
147                                        var letterSourceDetailValue = letterControl.getLetterSourceDetailValueForUpdate(letterSource);
148                                        var letterSourceDescription = letterControl.getLetterSourceDescriptionForUpdate(letterSource, getPreferredLanguage());
149                                        var description = edit.getDescription();
150                                        
151                                        letterSourceDetailValue.setLetterSourceName(edit.getLetterSourceName());
152                                        letterSourceDetailValue.setEmailAddressPartyContactMechanismPK(emailAddressPartyContactMechanism.getPrimaryKey());
153                                        letterSourceDetailValue.setPostalAddressPartyContactMechanismPK(postalAddressPartyContactMechanism.getPrimaryKey());
154                                        letterSourceDetailValue.setLetterSourcePartyContactMechanismPK(letterSourcePartyContactMechanism.getPrimaryKey());
155                                        letterSourceDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
156                                        letterSourceDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
157                                        
158                                        letterControl.updateLetterSourceFromValue(letterSourceDetailValue, partyPK);
159                                        
160                                        if(letterSourceDescription == null && description != null) {
161                                            letterControl.createLetterSourceDescription(letterSource, getPreferredLanguage(), description, partyPK);
162                                        } else if(letterSourceDescription != null && description == null) {
163                                            letterControl.deleteLetterSourceDescription(letterSourceDescription, partyPK);
164                                        } else if(letterSourceDescription != null && description != null) {
165                                            var letterSourceDescriptionValue = letterControl.getLetterSourceDescriptionValue(letterSourceDescription);
166                                            
167                                            letterSourceDescriptionValue.setDescription(description);
168                                            letterControl.updateLetterSourceDescriptionFromValue(letterSourceDescriptionValue, partyPK);
169                                        }
170                                    } finally {
171                                        unlockEntity(letterSource);
172                                    }
173                                } else {
174                                    addExecutionError(ExecutionErrors.EntityLockStale.name());
175                                }
176                            }
177                        }
178                    }
179                    
180                } else {
181                    addExecutionError(ExecutionErrors.DuplicateLetterSourceName.name(), letterSourceName);
182                }
183            } else {
184                addExecutionError(ExecutionErrors.UnknownLetterSourceName.name(), letterSourceName);
185            }
186            
187            if(hasExecutionErrors()) {
188                result.setLetterSource(letterControl.getLetterSourceTransfer(getUserVisit(), letterSource));
189                result.setEntityLock(getEntityLockTransfer(letterSource));
190            }
191        }
192        
193        return result;
194    }
195    
196}