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.DeleteRelatedItemForm;
020import com.echothree.model.control.item.server.control.ItemControl;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.data.item.server.entity.Item;
025import com.echothree.model.data.item.server.entity.RelatedItem;
026import com.echothree.model.data.item.server.entity.RelatedItemType;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.common.command.BaseResult;
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 DeleteRelatedItemCommand
042        extends BaseSimpleCommand<DeleteRelatedItemForm> {
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(Collections.unmodifiableList(Arrays.asList(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
051                        new SecurityRoleDefinition(SecurityRoleGroups.RelatedItem.name(), SecurityRoles.Delete.name())
052                )))
053        )));
054
055        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
056                new FieldDefinition("RelatedItemTypeName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("FromItemName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("ToItemName", FieldType.ENTITY_NAME, true, null, null)
059                ));
060    }
061    
062    /** Creates a new instance of DeleteRelatedItemCommand */
063    public DeleteRelatedItemCommand(UserVisitPK userVisitPK, DeleteRelatedItemForm form) {
064        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var itemControl = Session.getModelController(ItemControl.class);
070        String relatedItemTypeName = form.getRelatedItemTypeName();
071        RelatedItemType relatedItemType = itemControl.getRelatedItemTypeByName(relatedItemTypeName);
072        
073        if(relatedItemType != null) {
074            String fromItemName = form.getFromItemName();
075            Item fromItem = itemControl.getItemByName(fromItemName);
076            
077            if(fromItem != null) {
078                String toItemName = form.getToItemName();
079                Item toItem = itemControl.getItemByName(toItemName);
080                
081                if(toItem != null) {
082                    RelatedItem relatedItem = itemControl.getRelatedItemForUpdate(relatedItemType, fromItem, toItem);
083                    
084                    if(relatedItem != null) {
085                        itemControl.deleteRelatedItem(relatedItem, getPartyPK());
086                    } else {
087                        addExecutionError(ExecutionErrors.UnknownRelatedItem.name(), relatedItemTypeName, fromItemName, toItemName);
088                    }
089                } else {
090                    addExecutionError(ExecutionErrors.UnknownToItemName.name(), toItemName);
091                }
092            } else {
093                addExecutionError(ExecutionErrors.UnknownFromItemName.name(), fromItemName);
094            }
095        } else {
096            addExecutionError(ExecutionErrors.UnknownRelatedItemTypeName.name(), relatedItemTypeName);
097        }
098        
099        return null;
100    }
101    
102}