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.DeleteLocationNameElementForm;
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.party.server.entity.Party;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.model.data.warehouse.server.entity.LocationNameElement;
027import com.echothree.model.data.warehouse.server.entity.LocationType;
028import com.echothree.model.data.warehouse.server.entity.Warehouse;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
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 DeleteLocationNameElementCommand
043        extends BaseSimpleCommand<DeleteLocationNameElementForm> {
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(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.LocationNameElement.name(), SecurityRoles.Delete.name())
053                ))
054        ));
055
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057                new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("LocationTypeName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("LocationNameElementName", FieldType.ENTITY_NAME, true, null, null)
060                ));
061    }
062    
063    /** Creates a new instance of DeleteLocationNameElementCommand */
064    public DeleteLocationNameElementCommand(UserVisitPK userVisitPK, DeleteLocationNameElementForm form) {
065        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        var warehouseControl = Session.getModelController(WarehouseControl.class);
071        String warehouseName = form.getWarehouseName();
072        Warehouse warehouse = warehouseControl.getWarehouseByName(warehouseName);
073        
074        if(warehouse != null) {
075            Party warehouseParty = warehouse.getParty();
076            String locationTypeName = form.getLocationTypeName();
077            LocationType locationType = warehouseControl.getLocationTypeByName(warehouseParty, locationTypeName);
078            
079            if(locationType != null) {
080                String locationNameElementName = form.getLocationNameElementName();
081                LocationNameElement locationNameElement = warehouseControl.getLocationNameElementByNameForUpdate(locationType, locationNameElementName);
082                
083                if(locationNameElement != null) {
084                    warehouseControl.deleteLocationNameElement(locationNameElement, getPartyPK());
085                } else {
086                    addExecutionError(ExecutionErrors.UnknownLocationNameElementName.name(), locationNameElementName);
087                }
088            } else {
089                addExecutionError(ExecutionErrors.UnknownLocationTypeName.name(), locationTypeName);
090            }
091        } else {
092            addExecutionError(ExecutionErrors.UnknownWarehouseName.name(), warehouseName);
093        }
094        
095        return null;
096    }
097    
098}