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.warehouse.server.command;
018
019import com.echothree.control.user.warehouse.common.form.DeleteLocationForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.security.common.SecurityRoleGroups;
022import com.echothree.model.control.security.common.SecurityRoles;
023import com.echothree.model.control.warehouse.server.control.WarehouseControl;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.util.common.command.BaseResult;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import com.echothree.util.server.persistence.Session;
034import java.util.Arrays;
035import java.util.Collections;
036import java.util.List;
037import javax.enterprise.context.RequestScoped;
038
039@RequestScoped
040public class DeleteLocationCommand
041        extends BaseSimpleCommand<DeleteLocationForm> {
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.Location.name(), SecurityRoles.Delete.name())
051                ))
052        ));
053
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055                new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("LocationName", FieldType.ENTITY_NAME, true, null, null)
057                ));
058    }
059    
060    /** Creates a new instance of DeleteLocationCommand */
061    public DeleteLocationCommand() {
062        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
063    }
064    
065    @Override
066    protected BaseResult execute() {
067        var warehouseControl = Session.getModelController(WarehouseControl.class);
068        var warehouseName = form.getWarehouseName();
069        var warehouse = warehouseControl.getWarehouseByName(warehouseName);
070        
071        if(warehouse != null) {
072            var warehouseParty = warehouse.getParty();
073            var locationName = form.getLocationName();
074            var location = warehouseControl.getLocationByNameForUpdate(warehouseParty, locationName);
075            
076            if(location != null) {
077                // TODO: Verify there is no inventory in the location, perhaps by checking for InventoryAssignedLocations
078                
079                warehouseControl.deleteLocation(location, getPartyPK());
080            } else {
081                addExecutionError(ExecutionErrors.UnknownLocationName.name(), locationName);
082            }
083        } else {
084            addExecutionError(ExecutionErrors.UnknownWarehouseName.name(), warehouseName);
085        }
086        
087        return null;
088    }
089    
090}