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.DeleteEntityEntityAttributeForm;
020import com.echothree.model.control.core.common.EntityAttributeTypes;
021import com.echothree.model.control.core.server.logic.EntityAttributeLogic;
022import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.util.common.command.BaseResult;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.persistence.PersistenceUtils;
033import java.util.Arrays;
034import java.util.Collections;
035import java.util.List;
036
037public class DeleteEntityEntityAttributeCommand
038        extends BaseSimpleCommand<DeleteEntityEntityAttributeForm> {
039
040    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
041    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
042    
043    static {
044        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
045                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
046                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), null)
047        ));
048
049        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
050                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
051                new FieldDefinition("Key", FieldType.KEY, false, null, null),
052                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
053                new FieldDefinition("Ulid", FieldType.ULID, false, null, null),
054                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, false, null, null),
055                new FieldDefinition("EntityAttributeUlid", FieldType.ULID, false, null, null)
056                ));
057    }
058    
059    /** Creates a new instance of DeleteEntityEntityAttributeCommand */
060    public DeleteEntityEntityAttributeCommand(UserVisitPK userVisitPK, DeleteEntityEntityAttributeForm 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        var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(this, form);
068
069        if(!hasExecutionErrors()) {
070            var entityAttribute = EntityAttributeLogic.getInstance().getEntityAttribute(this, entityInstance, form, form,
071                    EntityAttributeTypes.ENTITY);
072
073            if(!hasExecutionErrors()) {
074                var entityEntityAttribute = coreControl.getEntityEntityAttributeForUpdate(entityAttribute, entityInstance);
075                
076                if(entityEntityAttribute != null) {
077                    coreControl.deleteEntityEntityAttribute(entityEntityAttribute, getPartyPK());
078                } else {
079                    var basePK = PersistenceUtils.getInstance().getBasePKFromEntityInstance(entityInstance);
080                    var entityTypeDetail = entityInstance.getEntityType().getLastDetail();
081
082                    addExecutionError(ExecutionErrors.UnknownEntityEntityAttribute.name(), basePK.getEntityRef(),
083                            entityTypeDetail.getComponentVendor().getLastDetail().getComponentVendorName(),
084                            entityTypeDetail.getEntityTypeName(), entityAttribute.getLastDetail().getEntityAttributeName());
085                }
086            }
087        }
088        
089        return null;
090    }
091    
092}