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.warehouse.server.command;
018
019import com.echothree.control.user.warehouse.common.form.DeleteLocationVolumeForm;
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.model.data.warehouse.server.entity.Location;
026import com.echothree.model.data.warehouse.server.entity.LocationVolume;
027import com.echothree.model.data.warehouse.server.entity.Warehouse;
028import com.echothree.util.common.command.BaseResult;
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.server.control.BaseSimpleCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import com.echothree.util.server.persistence.Session;
037import java.util.Arrays;
038import java.util.Collections;
039import java.util.List;
040
041public class DeleteLocationVolumeCommand
042        extends BaseSimpleCommand<DeleteLocationVolumeForm> {
043
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
051                        new SecurityRoleDefinition(SecurityRoleGroups.LocationVolume.name(), SecurityRoles.Delete.name())
052                ))
053        ));
054
055        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
056                new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("LocationName", FieldType.ENTITY_NAME, true, null, null)
058                ));
059    }
060    
061    /** Creates a new instance of DeleteLocationVolumeCommand */
062    public DeleteLocationVolumeCommand(UserVisitPK userVisitPK, DeleteLocationVolumeForm form) {
063        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var warehouseControl = Session.getModelController(WarehouseControl.class);
069        String warehouseName = form.getWarehouseName();
070        Warehouse warehouse = warehouseControl.getWarehouseByName(warehouseName);
071        
072        if(warehouse != null) {
073            String locationName = form.getLocationName();
074            Location location = warehouseControl.getLocationByName(warehouse.getParty(), locationName);
075            
076            if(location != null) {
077                LocationVolume locationVolume = warehouseControl.getLocationVolumeForUpdate(location);
078                
079                if(locationVolume != null) {
080                    warehouseControl.deleteLocationVolume(locationVolume, getPartyPK());
081                } else {
082                    addExecutionError(ExecutionErrors.UnknownLocationVolume.name());
083                }
084            } else {
085                addExecutionError(ExecutionErrors.UnknownLocationName.name(), locationName);
086            }
087        } else {
088            addExecutionError(ExecutionErrors.UnknownWarehouseName.name(), warehouseName);
089        }
090        
091        return null;
092    }
093    
094}