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.form.GetGeoCodeLanguageForm;
020import com.echothree.control.user.geo.common.result.GeoResultFactory;
021import com.echothree.model.control.geo.server.control.GeoControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.party.server.control.PartyControl;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.geo.server.entity.GeoCodeLanguage;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.server.control.BaseSingleEntityCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class GetGeoCodeLanguageCommand
041        extends BaseSingleEntityCommand<GeoCodeLanguage, GetGeoCodeLanguageForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.GeoCodeLanguage.name(), SecurityRoles.Review.name())
051                        ))
052                ));
053        
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("GeoCodeName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
057                );
058    }
059    
060    /** Creates a new instance of GetGeoCodeLanguageCommand */
061    public GetGeoCodeLanguageCommand() {
062        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
063    }
064    
065    @Inject
066    GeoControl geoControl;
067
068    @Inject
069    PartyControl partyControl;
070
071    @Override
072    protected GeoCodeLanguage getEntity() {
073        var geoCodeName = form.getGeoCodeName();
074        var geoCode = geoControl.getGeoCodeByName(geoCodeName);
075        GeoCodeLanguage geoCodeLanguage = null;
076
077        if(geoCode != null) {
078            var languageIsoName = form.getLanguageIsoName();
079            var language = partyControl.getLanguageByIsoName(languageIsoName);
080
081            if(language != null) {
082                geoCodeLanguage = geoControl.getGeoCodeLanguageForUpdate(geoCode, language);
083
084                if(geoCodeLanguage == null) {
085                    addExecutionError(ExecutionErrors.UnknownGeoCodeLanguage.name(), geoCodeName, languageIsoName);
086                }
087            } else {
088                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
089            }
090        } else {
091            addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), geoCodeName);
092        }
093
094        return geoCodeLanguage;
095    }
096
097    @Override
098    protected BaseResult getResult(GeoCodeLanguage geoCodeLanguage) {
099        var result = GeoResultFactory.getGetGeoCodeLanguageResult();
100
101        if(geoCodeLanguage != null) {
102            result.setGeoCodeLanguage(geoControl.getGeoCodeLanguageTransfer(getUserVisit(), geoCodeLanguage));
103        }
104
105        return result;
106    }
107    
108}