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.form.DeleteGeoCodeAliasForm;
020import com.echothree.model.control.geo.server.control.GeoControl;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.data.geo.server.entity.GeoCode;
025import com.echothree.model.data.geo.server.entity.GeoCodeAlias;
026import com.echothree.model.data.geo.server.entity.GeoCodeAliasType;
027import com.echothree.model.data.geo.server.entity.GeoCodeType;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.common.command.BaseResult;
033import com.echothree.util.server.control.BaseSimpleCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import com.echothree.util.server.persistence.Session;
038import java.util.Arrays;
039import java.util.Collections;
040import java.util.List;
041
042public class DeleteGeoCodeAliasCommand
043        extends BaseSimpleCommand<DeleteGeoCodeAliasForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                        new SecurityRoleDefinition(SecurityRoleGroups.GeoCodeAlias.name(), SecurityRoles.Delete.name())
053                        )))
054                )));
055        
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057                new FieldDefinition("GeoCodeName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("GeoCodeAliasTypeName", FieldType.ENTITY_NAME, true, null, null)
059                ));
060    }
061    
062    /** Creates a new instance of DeleteGeoCodeAliasCommand */
063    public DeleteGeoCodeAliasCommand(UserVisitPK userVisitPK, DeleteGeoCodeAliasForm form) {
064        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var geoControl = Session.getModelController(GeoControl.class);
070        String geoCodeName = form.getGeoCodeName();
071        GeoCode geoCode = geoControl.getGeoCodeByName(geoCodeName);
072
073        if(geoCode != null) {
074            GeoCodeType geoCodeType = geoCode.getLastDetail().getGeoCodeType();
075            String geoCodeAliasTypeName = form.getGeoCodeAliasTypeName();
076            GeoCodeAliasType geoCodeAliasType = geoControl.getGeoCodeAliasTypeByNameForUpdate(geoCodeType, geoCodeAliasTypeName);
077
078            if(geoCodeAliasType != null) {
079                if(!geoCodeAliasType.getLastDetail().getIsRequired()) {
080                    GeoCodeAlias geoCodeAlias = geoControl.getGeoCodeAliasForUpdate(geoCode, geoCodeAliasType);
081
082                    if(geoCodeAlias != null) {
083                        geoControl.deleteGeoCodeAlias(geoCodeAlias, getPartyPK());
084                    } else {
085                        addExecutionError(ExecutionErrors.UnknownGeoCodeAlias.name(), geoCodeName, geoCodeAliasTypeName);
086                    }
087                } else {
088                    addExecutionError(ExecutionErrors.CannotDeleteRequiredGeoCodeAlias.name(), geoCodeName, geoCodeAliasTypeName);
089                }
090            } else {
091                addExecutionError(ExecutionErrors.UnknownGeoCodeAliasTypeName.name(), geoCodeType.getLastDetail().getGeoCodeTypeName(), geoCodeAliasTypeName);
092            }
093        } else {
094            addExecutionError(ExecutionErrors.UnknownGeoCodeName.name(), geoCodeName);
095        }
096        
097        return null;
098    }
099    
100}