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.geo.server.command;
018
019import com.echothree.control.user.geo.common.edit.GeoCodeLanguageEdit;
020import com.echothree.control.user.geo.common.edit.GeoEditFactory;
021import com.echothree.control.user.geo.common.form.EditGeoCodeLanguageForm;
022import com.echothree.control.user.geo.common.result.GeoResultFactory;
023import com.echothree.control.user.geo.common.spec.GeoCodeLanguageSpec;
024import com.echothree.model.control.geo.server.control.GeoControl;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.party.server.control.PartyControl;
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 EditGeoCodeLanguageCommand
045        extends BaseEditCommand<GeoCodeLanguageSpec, GeoCodeLanguageEdit> {
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.GeoCodeLanguage.name(), SecurityRoles.Edit.name())
056                        ))
057                ));
058        
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("GeoCodeName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
062                );
063        
064        EDIT_FIELD_DEFINITIONS = List.of(
065                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
066                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null)
067                );
068    }
069    
070    /** Creates a new instance of EditGeoCodeLanguageCommand */
071    public EditGeoCodeLanguageCommand() {
072        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
073    }
074    
075    @Override
076    protected BaseResult execute() {
077        var geoControl = Session.getModelController(GeoControl.class);
078        var result = GeoResultFactory.getEditGeoCodeLanguageResult();
079        var geoCodeName = spec.getGeoCodeName();
080        var geoCode = geoControl.getGeoCodeByName(geoCodeName);
081        
082        if(geoCode != null) {
083            var partyControl = Session.getModelController(PartyControl.class);
084            var languageIsoName = spec.getLanguageIsoName();
085            var language = partyControl.getLanguageByIsoName(languageIsoName);
086            
087            if(language != null) {
088                if(editMode.equals(EditMode.LOCK)) {
089                    var geoCodeLanguage = geoControl.getGeoCodeLanguage(geoCode, language);
090                    
091                    if(geoCodeLanguage != null) {
092                        result.setGeoCodeLanguage(geoControl.getGeoCodeLanguageTransfer(getUserVisit(), geoCodeLanguage));
093                        
094                        if(lockEntity(geoCode)) {
095                            var edit = GeoEditFactory.getGeoCodeLanguageEdit();
096                            
097                            result.setEdit(edit);
098                            edit.setIsDefault(geoCodeLanguage.getIsDefault().toString());
099                            edit.setSortOrder(geoCodeLanguage.getSortOrder().toString());
100                            
101                        } else {
102                            addExecutionError(ExecutionErrors.EntityLockFailed.name());
103                        }
104                        
105                        result.setEntityLock(getEntityLockTransfer(geoCode));
106                    } else {
107                        addExecutionError(ExecutionErrors.UnknownGeoCodeLanguage.name(), geoCodeName, languageIsoName);
108                    }
109                } else if(editMode.equals(EditMode.UPDATE)) {
110                    var geoCodeLanguage = geoControl.getGeoCodeLanguageForUpdate(geoCode, language);
111                    
112                    if(geoCodeLanguage != null) {
113                        var geoCodeLanguageValue = geoControl.getGeoCodeLanguageValue(geoCodeLanguage);
114                        
115                        if(lockEntityForUpdate(geoCode)) {
116                            try {
117                                geoCodeLanguageValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
118                                geoCodeLanguageValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
119                                
120                                geoControl.updateGeoCodeLanguageFromValue(geoCodeLanguageValue, getPartyPK());
121                            } finally {
122                                unlockEntity(geoCode);
123                            }
124                        } else {
125                            addExecutionError(ExecutionErrors.EntityLockStale.name());
126                        }
127                    } else {
128                        addExecutionError(ExecutionErrors.UnknownGeoCodeLanguage.name(), geoCodeName, languageIsoName);
129                    }
130                    
131                    if(hasExecutionErrors()) {
132                        result.setGeoCodeLanguage(geoControl.getGeoCodeLanguageTransfer(getUserVisit(), geoCodeLanguage));
133                        result.setEntityLock(getEntityLockTransfer(geoCode));
134                    }
135                }
136            } else {
137                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
138            }
139        } else {
140            addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), geoCodeName);
141        }
142        
143        return result;
144    }
145    
146}