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.contact.server.command;
018
019import com.echothree.control.user.contact.common.edit.ContactEditFactory;
020import com.echothree.control.user.contact.common.edit.PostalAddressFormatDescriptionEdit;
021import com.echothree.control.user.contact.common.form.EditPostalAddressFormatDescriptionForm;
022import com.echothree.control.user.contact.common.result.ContactResultFactory;
023import com.echothree.control.user.contact.common.spec.PostalAddressFormatDescriptionSpec;
024import com.echothree.model.control.contact.server.control.ContactControl;
025import com.echothree.model.control.party.server.control.PartyControl;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.common.command.EditMode;
032import com.echothree.util.server.control.BaseEditCommand;
033import com.echothree.util.server.persistence.Session;
034import java.util.ArrayList;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037
038@Dependent
039public class EditPostalAddressFormatDescriptionCommand
040        extends BaseEditCommand<PostalAddressFormatDescriptionSpec, PostalAddressFormatDescriptionEdit> {
041    
042    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
043    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
044    
045    static {
046        SPEC_FIELD_DEFINITIONS = List.of(
047                new FieldDefinition("PostalAddressFormatName", FieldType.ENTITY_NAME, true, null, null),
048                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
049                );
050        
051        EDIT_FIELD_DEFINITIONS = List.of(
052                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
053                );
054    }
055    
056    /** Creates a new instance of EditPostalAddressFormatDescriptionCommand */
057    public EditPostalAddressFormatDescriptionCommand() {
058        super(null, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
059    }
060    
061    @Override
062    protected BaseResult execute() {
063        var contactControl = Session.getModelController(ContactControl.class);
064        var result = ContactResultFactory.getEditPostalAddressFormatDescriptionResult();
065        var postalAddressFormatName = spec.getPostalAddressFormatName();
066        var postalAddressFormat = contactControl.getPostalAddressFormatByName(postalAddressFormatName);
067        
068        if(postalAddressFormat != null) {
069            var partyControl = Session.getModelController(PartyControl.class);
070            var languageIsoName = spec.getLanguageIsoName();
071            var language = partyControl.getLanguageByIsoName(languageIsoName);
072            
073            result.setPostalAddressFormat(contactControl.getPostalAddressFormatTransfer(getUserVisit(), postalAddressFormat));
074            
075            if(language != null) {
076                result.setLanguage(partyControl.getLanguageTransfer(getUserVisit(), language));
077                
078                if(editMode.equals(EditMode.LOCK)) {
079                    var postalAddressFormatDescription = contactControl.getPostalAddressFormatDescription(postalAddressFormat, language);
080                    
081                    if(postalAddressFormatDescription != null) {
082                        result.setPostalAddressFormatDescription(contactControl.getPostalAddressFormatDescriptionTransfer(getUserVisit(), postalAddressFormatDescription));
083                        
084                        if(lockEntity(postalAddressFormat)) {
085                            var edit = ContactEditFactory.getPostalAddressFormatDescriptionEdit();
086                            
087                            result.setEdit(edit);
088                            edit.setDescription(postalAddressFormatDescription.getDescription());
089                        } else {
090                            addExecutionError(ExecutionErrors.EntityLockFailed.name());
091                        }
092                        
093                        result.setEntityLock(getEntityLockTransfer(postalAddressFormat));
094                    } else {
095                        addExecutionError(ExecutionErrors.UnknownPostalAddressFormatDescription.name());
096                    }
097                } else if(editMode.equals(EditMode.UPDATE)) {
098                    var postalAddressFormatDescriptionValue = contactControl.getPostalAddressFormatDescriptionValueForUpdate(postalAddressFormat, language);
099                    
100                    if(postalAddressFormatDescriptionValue != null) {
101                        if(lockEntityForUpdate(postalAddressFormat)) {
102                            try {
103                                var description = edit.getDescription();
104                                
105                                postalAddressFormatDescriptionValue.setDescription(description);
106                                
107                                contactControl.updatePostalAddressFormatDescriptionFromValue(postalAddressFormatDescriptionValue, getPartyPK());
108                            } finally {
109                                unlockEntity(postalAddressFormat);
110                            }
111                        } else {
112                            addExecutionError(ExecutionErrors.EntityLockStale.name());
113                        }
114                    } else {
115                        addExecutionError(ExecutionErrors.UnknownPostalAddressFormatDescription.name());
116                    }
117                }
118            } else {
119                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
120            }
121        } else {
122            addExecutionError(ExecutionErrors.UnknownPostalAddressFormatName.name(), postalAddressFormatName);
123        }
124        
125        return result;
126    }
127    
128}