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.core.server.command;
018
019import com.echothree.control.user.core.common.form.DeleteEntityBlobAttributeForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.party.server.control.PartyControl;
022import com.echothree.model.data.core.server.entity.EntityAttribute;
023import com.echothree.model.data.core.server.entity.EntityBlobAttribute;
024import com.echothree.model.data.core.server.entity.EntityInstance;
025import com.echothree.model.data.core.server.entity.EntityTypeDetail;
026import com.echothree.model.data.party.server.entity.Language;
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.persistence.Session;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039
040public class DeleteEntityBlobAttributeCommand
041        extends BaseSimpleCommand<DeleteEntityBlobAttributeForm> {
042
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), null)
050        ));
051
052        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
053                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, true, null, null),
054                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
056                ));
057    }
058    
059    /** Creates a new instance of DeleteEntityBlobAttributeCommand */
060    public DeleteEntityBlobAttributeCommand(UserVisitPK userVisitPK, DeleteEntityBlobAttributeForm form) {
061        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
062    }
063    
064    @Override
065    protected BaseResult execute() {
066        var coreControl = getCoreControl();
067        String entityRef = form.getEntityRef();
068        EntityInstance entityInstance = coreControl.getEntityInstanceByEntityRef(entityRef);
069        
070        if(entityInstance != null) {
071            String entityAttributeName = form.getEntityAttributeName();
072            EntityAttribute entityAttribute = coreControl.getEntityAttributeByName(entityInstance.getEntityType(), entityAttributeName);
073            
074            if(entityAttribute != null) {
075                var partyControl = Session.getModelController(PartyControl.class);
076                String languageIsoName = form.getLanguageIsoName();
077                Language language = partyControl.getLanguageByIsoName(languageIsoName);
078                
079                if(language != null) {
080                    EntityBlobAttribute entityBlobAttribute = coreControl.getEntityBlobAttributeForUpdate(entityAttribute, entityInstance, language);
081                    
082                    if(entityBlobAttribute != null) {
083                        coreControl.deleteEntityBlobAttribute(entityBlobAttribute, getPartyPK());
084                    } else {
085                        addExecutionError(ExecutionErrors.UnknownEntityBlobAttribute.name());
086                    }
087                } else {
088                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
089                }
090            } else {
091                EntityTypeDetail entityTypeDetail = entityInstance.getEntityType().getLastDetail();
092                
093                addExecutionError(ExecutionErrors.UnknownEntityAttributeName.name(), entityTypeDetail.getComponentVendor().getLastDetail().getComponentVendorName(),
094                        entityTypeDetail.getEntityTypeName(), entityAttributeName);
095            }
096        } else {
097            addExecutionError(ExecutionErrors.UnknownEntityRef.name(), entityRef);
098        }
099        
100        return null;
101    }
102    
103}