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.item.server.command;
018
019import com.echothree.control.user.item.common.form.DeleteItemCategoryForm;
020import com.echothree.model.control.core.common.ComponentVendors;
021import com.echothree.model.control.core.common.EntityTypes;
022import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
023import com.echothree.model.control.item.server.control.ItemControl;
024import com.echothree.model.control.item.server.logic.ItemCategoryLogic;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.data.core.server.entity.EntityInstance;
029import com.echothree.model.data.item.server.entity.ItemCategory;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.BaseResult;
035import com.echothree.util.server.control.BaseSimpleCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.Arrays;
041import java.util.Collections;
042import java.util.List;
043
044public class DeleteItemCategoryCommand
045        extends BaseSimpleCommand<DeleteItemCategoryForm> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
049    
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
054                        new SecurityRoleDefinition(SecurityRoleGroups.ItemCategory.name(), SecurityRoles.Delete.name())
055                        )))
056                )));
057        
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("ItemCategoryName", FieldType.ENTITY_NAME, false, null, null),
060                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
061                new FieldDefinition("Key", FieldType.KEY, false, null, null),
062                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
063                new FieldDefinition("Ulid", FieldType.ULID, false, null, null)
064                ));
065    }
066    
067    /** Creates a new instance of DeleteItemCategoryCommand */
068    public DeleteItemCategoryCommand(UserVisitPK userVisitPK, DeleteItemCategoryForm form) {
069        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
070    }
071    
072    @Override
073    protected BaseResult execute() {
074        String itemCategoryName = form.getItemCategoryName();
075        var parameterCount = (itemCategoryName == null ? 0 : 1) + EntityInstanceLogic.getInstance().countPossibleEntitySpecs(form);
076
077        if(parameterCount == 1) {
078            var itemControl = Session.getModelController(ItemControl.class);
079            ItemCategory itemCategory = null;
080            
081            if(itemCategoryName == null) {
082                var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(this, form, ComponentVendors.ECHO_THREE.name(),
083                        EntityTypes.ItemCategory.name());
084                
085                if(!hasExecutionErrors()) {
086                    itemCategory = itemControl.getItemCategoryByEntityInstanceForUpdate(entityInstance);
087                }
088            } else {
089                itemCategory = ItemCategoryLogic.getInstance().getItemCategoryByNameForUpdate(this, itemCategoryName);
090            }
091            
092            if(!hasExecutionErrors()) {
093                ItemCategoryLogic itemCategoryLogic = ItemCategoryLogic.getInstance();
094
095                itemCategoryLogic.checkDeleteItemCategory(this, itemCategory);
096
097                if(!hasExecutionErrors()) {
098                    itemCategoryLogic.deleteItemCategory(itemCategory, getPartyPK());
099                }
100            }
101        } else {
102            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
103        }
104        
105        return null;
106    }
107    
108}