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.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.Arrays;
041import java.util.Collections;
042import java.util.List;
043import javax.enterprise.context.RequestScoped;
044
045@RequestScoped
046public class EditGeoCodeDescriptionCommand
047        extends BaseEditCommand<GeoCodeDescriptionSpec, GeoCodeDescriptionEdit> {
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.GeoCode.name(), SecurityRoles.Description.name())
058                        )))
059                )));
060        
061        
062        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
063                new FieldDefinition("GeoCodeName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
065                ));
066        
067        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
068                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
069                ));
070    }
071    
072    /** Creates a new instance of EditGeoCodeDescriptionCommand */
073    public EditGeoCodeDescriptionCommand() {
074        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
075    }
076    
077    @Override
078    protected BaseResult execute() {
079        var geoControl = Session.getModelController(GeoControl.class);
080        var result = GeoResultFactory.getEditGeoCodeDescriptionResult();
081        var geoCodeName = spec.getGeoCodeName();
082        var geoCode = geoControl.getGeoCodeByName(geoCodeName);
083        
084        if(geoCode != null) {
085            var partyControl = Session.getModelController(PartyControl.class);
086            var languageIsoName = spec.getLanguageIsoName();
087            var language = partyControl.getLanguageByIsoName(languageIsoName);
088            
089            if(language != null) {
090                if(editMode.equals(EditMode.LOCK)) {
091                    var geoCodeDescription = geoControl.getGeoCodeDescription(geoCode, language);
092                    
093                    if(geoCodeDescription != null) {
094                        result.setGeoCodeDescription(geoControl.getGeoCodeDescriptionTransfer(getUserVisit(), geoCodeDescription));
095                        
096                        if(lockEntity(geoCode)) {
097                            var edit = GeoEditFactory.getGeoCodeDescriptionEdit();
098                            
099                            result.setEdit(edit);
100                            edit.setDescription(geoCodeDescription.getDescription());
101                        } else {
102                            addExecutionError(ExecutionErrors.EntityLockFailed.name());
103                        }
104                        
105                        result.setEntityLock(getEntityLockTransfer(geoCode));
106                    } else {
107                        addExecutionError(ExecutionErrors.UnknownGeoCodeDescription.name(), geoCodeName, languageIsoName);
108                    }
109                } else if(editMode.equals(EditMode.UPDATE)) {
110                    var geoCodeDescriptionValue = geoControl.getGeoCodeDescriptionValueForUpdate(geoCode, language);
111                    
112                    if(geoCodeDescriptionValue != null) {
113                        if(lockEntityForUpdate(geoCode)) {
114                            try {
115                                var description = edit.getDescription();
116                                
117                                geoCodeDescriptionValue.setDescription(description);
118                                
119                                geoControl.updateGeoCodeDescriptionFromValue(geoCodeDescriptionValue, getPartyPK());
120                            } finally {
121                                unlockEntity(geoCode);
122                            }
123                        } else {
124                            addExecutionError(ExecutionErrors.EntityLockStale.name());
125                        }
126                    } else {
127                        addExecutionError(ExecutionErrors.UnknownGeoCodeDescription.name(), geoCodeName, languageIsoName);
128                    }
129                }
130            } else {
131                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
132            }
133        } else {
134            addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), geoCodeName);
135        }
136        
137        return result;
138    }
139    
140}