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