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.party.server.command;
018
019import com.echothree.control.user.party.common.edit.CompanyEdit;
020import com.echothree.control.user.party.common.edit.PartyEditFactory;
021import com.echothree.control.user.party.common.form.EditCompanyForm;
022import com.echothree.control.user.party.common.result.EditCompanyResult;
023import com.echothree.control.user.party.common.result.PartyResultFactory;
024import com.echothree.control.user.party.common.spec.CompanySpec;
025import com.echothree.model.control.accounting.server.control.AccountingControl;
026import com.echothree.model.control.party.server.control.PartyControl;
027import com.echothree.model.data.accounting.server.entity.Currency;
028import com.echothree.model.data.party.common.pk.PartyPK;
029import com.echothree.model.data.party.server.entity.DateTimeFormat;
030import com.echothree.model.data.party.server.entity.Language;
031import com.echothree.model.data.party.server.entity.Party;
032import com.echothree.model.data.party.server.entity.PartyCompany;
033import com.echothree.model.data.party.server.entity.PartyDetail;
034import com.echothree.model.data.party.server.entity.PartyGroup;
035import com.echothree.model.data.party.server.entity.TimeZone;
036import com.echothree.model.data.party.server.value.PartyCompanyValue;
037import com.echothree.model.data.party.server.value.PartyDetailValue;
038import com.echothree.model.data.party.server.value.PartyGroupValue;
039import com.echothree.model.data.user.common.pk.UserVisitPK;
040import com.echothree.util.common.message.ExecutionErrors;
041import com.echothree.util.common.validation.FieldDefinition;
042import com.echothree.util.common.validation.FieldType;
043import com.echothree.util.common.command.BaseResult;
044import com.echothree.util.common.command.EditMode;
045import com.echothree.util.server.control.BaseEditCommand;
046import com.echothree.util.server.persistence.Session;
047import java.util.Arrays;
048import java.util.Collections;
049import java.util.List;
050
051public class EditCompanyCommand
052        extends BaseEditCommand<CompanySpec, CompanyEdit> {
053    
054    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
055    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
056    
057    static {
058        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("CompanyName", FieldType.ENTITY_NAME, true, null, null)
060                ));
061        
062        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
063                new FieldDefinition("CompanyName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("Name", FieldType.STRING, true, 1L, 60L),
065                new FieldDefinition("PreferredLanguageIsoName", FieldType.ENTITY_NAME, false, null, null),
066                new FieldDefinition("PreferredCurrencyIsoName", FieldType.ENTITY_NAME, false, null, null),
067                new FieldDefinition("PreferredJavaTimeZoneName", FieldType.TIME_ZONE_NAME, false, null, null),
068                new FieldDefinition("PreferredDateTimeFormatName", FieldType.ENTITY_NAME, false, null, null),
069                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
070                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null)
071                ));
072    }
073    
074    /** Creates a new instance of EditCompanyCommand */
075    public EditCompanyCommand(UserVisitPK userVisitPK, EditCompanyForm form) {
076        super(userVisitPK, form, null, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
077    }
078    
079    @Override
080    protected BaseResult execute() {
081        var partyControl = Session.getModelController(PartyControl.class);
082        EditCompanyResult result = PartyResultFactory.getEditCompanyResult();
083        String originalCompanyName = spec.getCompanyName();
084        PartyCompany partyCompany = partyControl.getPartyCompanyByNameForUpdate(originalCompanyName);
085        
086        if(partyCompany != null) {
087            Party party = partyCompany.getParty();
088            
089            if(editMode.equals(EditMode.LOCK)) {
090                result.setCompany(partyControl.getCompanyTransfer(getUserVisit(), partyCompany));
091                
092                if(lockEntity(party)) {
093                    CompanyEdit edit = PartyEditFactory.getCompanyEdit();
094                    PartyDetail partyDetail = party.getLastDetail();
095                    PartyGroup partyGroup = partyControl.getPartyGroup(party);
096                    Language preferredLanguage = partyDetail.getPreferredLanguage();
097                    Currency preferredCurrency = partyDetail.getPreferredCurrency();
098                    TimeZone preferredTimeZone = partyDetail.getPreferredTimeZone();
099                    DateTimeFormat preferredDateTimeFormat = partyDetail.getPreferredDateTimeFormat();
100                    
101                    result.setEdit(edit);
102                    edit.setCompanyName(partyCompany.getPartyCompanyName());
103                    edit.setName(partyGroup.getName());
104                    edit.setPreferredLanguageIsoName(preferredLanguage == null? null: preferredLanguage.getLanguageIsoName());
105                    edit.setPreferredCurrencyIsoName(preferredCurrency == null? null: preferredCurrency.getCurrencyIsoName());
106                    edit.setPreferredJavaTimeZoneName(preferredTimeZone == null? null: preferredTimeZone.getLastDetail().getJavaTimeZoneName());
107                    edit.setPreferredDateTimeFormatName(preferredDateTimeFormat == null? null: preferredDateTimeFormat.getLastDetail().getDateTimeFormatName());
108                    edit.setIsDefault(partyCompany.getIsDefault().toString());
109                    edit.setSortOrder(partyCompany.getSortOrder().toString());
110                } else {
111                    addExecutionError(ExecutionErrors.EntityLockFailed.name());
112                }
113                
114                result.setEntityLock(getEntityLockTransfer(party));
115            } else if(editMode.equals(EditMode.ABANDON)) {
116                unlockEntity(party);
117            } else if(editMode.equals(EditMode.UPDATE)) {
118                PartyCompanyValue partyCompanyValue = partyControl.getPartyCompanyValueForUpdate(partyCompany);
119                String companyName = edit.getCompanyName();
120                PartyCompany duplicatePartyCompany = partyControl.getPartyCompanyByName(companyName);
121                
122                if(duplicatePartyCompany == null || duplicatePartyCompany.getPrimaryKey().equals(partyCompanyValue.getPrimaryKey())) {
123                    String preferredLanguageIsoName = edit.getPreferredLanguageIsoName();
124                    Language preferredLanguage = preferredLanguageIsoName == null? null: partyControl.getLanguageByIsoName(preferredLanguageIsoName);
125                    
126                    if(preferredLanguageIsoName == null || (preferredLanguage != null)) {
127                        String preferredJavaTimeZoneName = edit.getPreferredJavaTimeZoneName();
128                        TimeZone preferredTimeZone = preferredJavaTimeZoneName == null? null: partyControl.getTimeZoneByJavaName(preferredJavaTimeZoneName);
129                        
130                        if(preferredJavaTimeZoneName == null || (preferredTimeZone != null)) {
131                            String preferredDateTimeFormatName = edit.getPreferredDateTimeFormatName();
132                            DateTimeFormat preferredDateTimeFormat = preferredDateTimeFormatName == null? null: partyControl.getDateTimeFormatByName(preferredDateTimeFormatName);
133                            
134                            if(preferredDateTimeFormatName == null || (preferredDateTimeFormat != null)) {
135                                String preferredCurrencyIsoName = edit.getPreferredCurrencyIsoName();
136                                Currency preferredCurrency;
137                                
138                                if(preferredCurrencyIsoName == null)
139                                    preferredCurrency = null;
140                                else {
141                                    var accountingControl = Session.getModelController(AccountingControl.class);
142                                    preferredCurrency = accountingControl.getCurrencyByIsoName(preferredCurrencyIsoName);
143                                }
144                                
145                                if(preferredCurrencyIsoName == null || (preferredCurrency != null)) {
146                                    if(lockEntityForUpdate(party)) {
147                                        try {
148                                            PartyPK updatedBy = getPartyPK();
149                                            PartyDetailValue partyDetailValue = partyControl.getPartyDetailValueForUpdate(party);
150                                            PartyGroupValue partyGroupValue = partyControl.getPartyGroupValueForUpdate(party);
151                                            
152                                            partyCompanyValue.setPartyCompanyName(companyName);
153                                            partyGroupValue.setName(edit.getName());
154                                            partyCompanyValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
155                                            partyCompanyValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
156                                            
157                                            partyControl.updatePartyCompanyFromValue(partyCompanyValue, updatedBy);
158                                            partyControl.updatePartyFromValue(partyDetailValue, updatedBy);
159                                            partyControl.updatePartyGroupFromValue(partyGroupValue, updatedBy);
160                                        } finally {
161                                            unlockEntity(party);
162                                        }
163                                    } else {
164                                        addExecutionError(ExecutionErrors.EntityLockStale.name());
165                                    }
166                                } else {
167                                    addExecutionError(ExecutionErrors.UnknownCurrencyIsoName.name(), preferredCurrencyIsoName);
168                                }
169                            } else {
170                                addExecutionError(ExecutionErrors.UnknownDateTimeFormatName.name(), preferredDateTimeFormatName);
171                            }
172                        } else {
173                            addExecutionError(ExecutionErrors.UnknownJavaTimeZoneName.name(), preferredJavaTimeZoneName);
174                        }
175                    } else {
176                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), preferredLanguageIsoName);
177                    }
178                } else {
179                    addExecutionError(ExecutionErrors.DuplicateCompanyName.name(), companyName);
180                }
181                
182                if(hasExecutionErrors()) {
183                    result.setCompany(partyControl.getCompanyTransfer(getUserVisit(), partyCompany));
184                    result.setEntityLock(getEntityLockTransfer(party));
185                }
186            }
187        } else {
188            addExecutionError(ExecutionErrors.UnknownCompanyName.name(), originalCompanyName);
189        }
190        
191        return result;
192    }
193    
194}