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.DeleteWarehouseForm;
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.logic.WarehouseLogic;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.util.common.command.BaseResult;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.server.control.BaseSimpleCommand;
029import com.echothree.util.server.control.CommandSecurityDefinition;
030import com.echothree.util.server.control.PartyTypeDefinition;
031import com.echothree.util.server.control.SecurityRoleDefinition;
032import java.util.List;
033
034public class DeleteWarehouseCommand
035        extends BaseSimpleCommand<DeleteWarehouseForm> {
036
037    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
038    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
039    
040    static {
041        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
042                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
043                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
044                        new SecurityRoleDefinition(SecurityRoleGroups.Warehouse.name(), SecurityRoles.Delete.name())
045                ))
046        ));
047
048        FORM_FIELD_DEFINITIONS = List.of(
049                new FieldDefinition("WarehouseName", FieldType.ENTITY_NAME, false, null, null),
050                new FieldDefinition("PartyName", FieldType.ENTITY_NAME, false, null, null),
051                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
052                new FieldDefinition("Key", FieldType.KEY, false, null, null),
053                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
054                new FieldDefinition("Ulid", FieldType.ULID, false, null, null)
055        );
056    }
057    
058    /** Creates a new instance of DeleteWarehouseCommand */
059    public DeleteWarehouseCommand(UserVisitPK userVisitPK, DeleteWarehouseForm form) {
060        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
061    }
062    
063    @Override
064    protected BaseResult execute() {
065        var warehouse = WarehouseLogic.getInstance().getWarehouseByUniversalSpecForUpdate(this, form, false);
066        
067        if(!hasExecutionErrors()) {
068            WarehouseLogic.getInstance().deleteWarehouse(this, warehouse, getPartyPK());
069        }
070        
071        return null;
072    }
073    
074}