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.DeleteItemDescriptionForm;
020import com.echothree.model.control.item.server.control.ItemControl;
021import com.echothree.model.control.item.server.logic.ItemDescriptionLogic;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.party.server.control.PartyControl;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.item.server.entity.Item;
027import com.echothree.model.data.item.server.entity.ItemDescription;
028import com.echothree.model.data.item.server.entity.ItemDescriptionType;
029import com.echothree.model.data.party.server.entity.Language;
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 DeleteItemDescriptionCommand
045        extends BaseSimpleCommand<DeleteItemDescriptionForm> {
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.ItemDescription.name(), SecurityRoles.Delete.name())
055                        )))
056                )));
057
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("ItemName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("ItemDescriptionTypeName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
062                ));
063    }
064    
065    /** Creates a new instance of DeleteItemDescriptionCommand */
066    public DeleteItemDescriptionCommand(UserVisitPK userVisitPK, DeleteItemDescriptionForm form) {
067        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
068    }
069    
070    @Override
071    protected BaseResult execute() {
072        var itemControl = Session.getModelController(ItemControl.class);
073        String itemName = form.getItemName();
074        Item item = itemControl.getItemByName(itemName);
075        
076        if(item != null) {
077            String itemDescriptionTypeName = form.getItemDescriptionTypeName();
078            ItemDescriptionType itemDescriptionType = itemControl.getItemDescriptionTypeByName(itemDescriptionTypeName);
079            
080            if(itemDescriptionType != null) {
081                var partyControl = Session.getModelController(PartyControl.class);
082                String languageIsoName = form.getLanguageIsoName();
083                Language language = partyControl.getLanguageByIsoName(languageIsoName);
084                
085                if(language != null) {
086                    ItemDescription itemDescription = itemControl.getItemDescriptionForUpdate(itemDescriptionType, item, language);
087                    
088                    if(itemDescription != null) {
089                        ItemDescriptionLogic.getInstance().deleteItemDescription(itemDescription, getPartyPK());
090                    } else {
091                        addExecutionError(ExecutionErrors.UnknownItemDescription.name(), itemName, itemDescriptionTypeName, languageIsoName);
092                    }
093                } else {
094                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
095                }
096            } else {
097                addExecutionError(ExecutionErrors.UnknownItemDescriptionTypeName.name(), itemDescriptionTypeName);
098            }
099        } else {
100            addExecutionError(ExecutionErrors.UnknownItemName.name(), itemName);
101        }
102        
103        return null;
104    }
105    
106}