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.GeoCodeDescriptionEdit;
020import com.echothree.control.user.geo.common.edit.GeoEditFactory;
021import com.echothree.control.user.geo.common.form.EditGeoCodeDescriptionForm;
022import com.echothree.control.user.geo.common.result.GeoResultFactory;
023import com.echothree.control.user.geo.common.spec.GeoCodeDescriptionSpec;
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 EditGeoCodeDescriptionCommand
045        extends BaseEditCommand<GeoCodeDescriptionSpec, GeoCodeDescriptionEdit> {
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.GeoCode.name(), SecurityRoles.Description.name())
056                        ))
057                ));
058        
059        
060        SPEC_FIELD_DEFINITIONS = List.of(
061                new FieldDefinition("GeoCodeName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
063                );
064        
065        EDIT_FIELD_DEFINITIONS = List.of(
066                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
067                );
068    }
069    
070    /** Creates a new instance of EditGeoCodeDescriptionCommand */
071    public EditGeoCodeDescriptionCommand() {
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.getEditGeoCodeDescriptionResult();
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 geoCodeDescription = geoControl.getGeoCodeDescription(geoCode, language);
090                    
091                    if(geoCodeDescription != null) {
092                        result.setGeoCodeDescription(geoControl.getGeoCodeDescriptionTransfer(getUserVisit(), geoCodeDescription));
093                        
094                        if(lockEntity(geoCode)) {
095                            var edit = GeoEditFactory.getGeoCodeDescriptionEdit();
096                            
097                            result.setEdit(edit);
098                            edit.setDescription(geoCodeDescription.getDescription());
099                        } else {
100                            addExecutionError(ExecutionErrors.EntityLockFailed.name());
101                        }
102                        
103                        result.setEntityLock(getEntityLockTransfer(geoCode));
104                    } else {
105                        addExecutionError(ExecutionErrors.UnknownGeoCodeDescription.name(), geoCodeName, languageIsoName);
106                    }
107                } else if(editMode.equals(EditMode.UPDATE)) {
108                    var geoCodeDescriptionValue = geoControl.getGeoCodeDescriptionValueForUpdate(geoCode, language);
109                    
110                    if(geoCodeDescriptionValue != null) {
111                        if(lockEntityForUpdate(geoCode)) {
112                            try {
113                                var description = edit.getDescription();
114                                
115                                geoCodeDescriptionValue.setDescription(description);
116                                
117                                geoControl.updateGeoCodeDescriptionFromValue(geoCodeDescriptionValue, getPartyPK());
118                            } finally {
119                                unlockEntity(geoCode);
120                            }
121                        } else {
122                            addExecutionError(ExecutionErrors.EntityLockStale.name());
123                        }
124                    } else {
125                        addExecutionError(ExecutionErrors.UnknownGeoCodeDescription.name(), geoCodeName, languageIsoName);
126                    }
127                }
128            } else {
129                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
130            }
131        } else {
132            addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), geoCodeName);
133        }
134        
135        return result;
136    }
137    
138}