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