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.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.EditGeoCodeDescriptionResult;
023import com.echothree.control.user.geo.common.result.GeoResultFactory;
024import com.echothree.control.user.geo.common.spec.GeoCodeDescriptionSpec;
025import com.echothree.model.control.geo.server.control.GeoControl;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.party.server.control.PartyControl;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.geo.server.entity.GeoCode;
031import com.echothree.model.data.geo.server.entity.GeoCodeDescription;
032import com.echothree.model.data.geo.server.value.GeoCodeDescriptionValue;
033import com.echothree.model.data.party.server.entity.Language;
034import com.echothree.model.data.user.common.pk.UserVisitPK;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.validation.FieldDefinition;
037import com.echothree.util.common.validation.FieldType;
038import com.echothree.util.common.command.BaseResult;
039import com.echothree.util.common.command.EditMode;
040import com.echothree.util.server.control.BaseEditCommand;
041import com.echothree.util.server.control.CommandSecurityDefinition;
042import com.echothree.util.server.control.PartyTypeDefinition;
043import com.echothree.util.server.control.SecurityRoleDefinition;
044import com.echothree.util.server.persistence.Session;
045import java.util.Arrays;
046import java.util.Collections;
047import java.util.List;
048
049public class EditGeoCodeDescriptionCommand
050        extends BaseEditCommand<GeoCodeDescriptionSpec, GeoCodeDescriptionEdit> {
051    
052    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
053    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
054    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
055    
056    static {
057        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
058                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
059                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
060                        new SecurityRoleDefinition(SecurityRoleGroups.GeoCode.name(), SecurityRoles.Description.name())
061                        )))
062                )));
063        
064        
065        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
066                new FieldDefinition("GeoCodeName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
068                ));
069        
070        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
071                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
072                ));
073    }
074    
075    /** Creates a new instance of EditGeoCodeDescriptionCommand */
076    public EditGeoCodeDescriptionCommand(UserVisitPK userVisitPK, EditGeoCodeDescriptionForm form) {
077        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
078    }
079    
080    @Override
081    protected BaseResult execute() {
082        var geoControl = Session.getModelController(GeoControl.class);
083        EditGeoCodeDescriptionResult result = GeoResultFactory.getEditGeoCodeDescriptionResult();
084        String geoCodeName = spec.getGeoCodeName();
085        GeoCode geoCode = geoControl.getGeoCodeByName(geoCodeName);
086        
087        if(geoCode != null) {
088            var partyControl = Session.getModelController(PartyControl.class);
089            String languageIsoName = spec.getLanguageIsoName();
090            Language language = partyControl.getLanguageByIsoName(languageIsoName);
091            
092            if(language != null) {
093                if(editMode.equals(EditMode.LOCK)) {
094                    GeoCodeDescription geoCodeDescription = geoControl.getGeoCodeDescription(geoCode, language);
095                    
096                    if(geoCodeDescription != null) {
097                        result.setGeoCodeDescription(geoControl.getGeoCodeDescriptionTransfer(getUserVisit(), geoCodeDescription));
098                        
099                        if(lockEntity(geoCode)) {
100                            GeoCodeDescriptionEdit edit = GeoEditFactory.getGeoCodeDescriptionEdit();
101                            
102                            result.setEdit(edit);
103                            edit.setDescription(geoCodeDescription.getDescription());
104                        } else {
105                            addExecutionError(ExecutionErrors.EntityLockFailed.name());
106                        }
107                        
108                        result.setEntityLock(getEntityLockTransfer(geoCode));
109                    } else {
110                        addExecutionError(ExecutionErrors.UnknownGeoCodeDescription.name(), geoCodeName, languageIsoName);
111                    }
112                } else if(editMode.equals(EditMode.UPDATE)) {
113                    GeoCodeDescriptionValue geoCodeDescriptionValue = geoControl.getGeoCodeDescriptionValueForUpdate(geoCode, language);
114                    
115                    if(geoCodeDescriptionValue != null) {
116                        if(lockEntityForUpdate(geoCode)) {
117                            try {
118                                String description = edit.getDescription();
119                                
120                                geoCodeDescriptionValue.setDescription(description);
121                                
122                                geoControl.updateGeoCodeDescriptionFromValue(geoCodeDescriptionValue, getPartyPK());
123                            } finally {
124                                unlockEntity(geoCode);
125                            }
126                        } else {
127                            addExecutionError(ExecutionErrors.EntityLockStale.name());
128                        }
129                    } else {
130                        addExecutionError(ExecutionErrors.UnknownGeoCodeDescription.name(), geoCodeName, languageIsoName);
131                    }
132                }
133            } else {
134                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
135            }
136        } else {
137            addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), geoCodeName);
138        }
139        
140        return result;
141    }
142    
143}