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.DeleteEntityCollectionAttributeForm;
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 java.util.Arrays;
033import java.util.Collections;
034import java.util.List;
035
036public class DeleteEntityCollectionAttributeCommand
037        extends BaseSimpleCommand<DeleteEntityCollectionAttributeForm> {
038
039    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
040    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
041    
042    static {
043        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
044                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
045                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), null)
046        ));
047
048        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
049                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
050                new FieldDefinition("Key", FieldType.KEY, false, null, null),
051                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
052                new FieldDefinition("Ulid", FieldType.ULID, false, null, null),
053                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, false, null, null),
054                new FieldDefinition("EntityAttributeUlid", FieldType.ULID, false, null, null),
055                new FieldDefinition("EntityRefAttribute", FieldType.ENTITY_REF, true, null, null)
056                ));
057    }
058    
059    /** Creates a new instance of DeleteEntityCollectionAttributeCommand */
060    public DeleteEntityCollectionAttributeCommand(UserVisitPK userVisitPK, DeleteEntityCollectionAttributeForm form) {
061        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
062    }
063    
064    @Override
065    protected BaseResult execute() {
066        var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(this, form);
067
068        if(!hasExecutionErrors()) {
069            var entityAttribute = EntityAttributeLogic.getInstance().getEntityAttribute(this, entityInstance, form, form,
070                    EntityAttributeTypes.COLLECTION);
071
072            if(!hasExecutionErrors()) {
073                var coreControl = getCoreControl();
074                var entityRefAttribute = form.getEntityRefAttribute();
075                var entityInstanceAttribute = coreControl.getEntityInstanceByEntityRef(entityRefAttribute);
076
077                if(entityInstanceAttribute != null) {
078                    var entityCollectionAttribute = coreControl.getEntityCollectionAttributeForUpdate(entityAttribute, entityInstance, entityInstanceAttribute);
079                    
080                    if(entityCollectionAttribute != null) {
081                        coreControl.deleteEntityCollectionAttribute(entityCollectionAttribute, getPartyPK());
082                    } else {
083                        addExecutionError(ExecutionErrors.UnknownEntityCollectionAttribute.name(),
084                                EntityInstanceLogic.getInstance().getEntityRefFromEntityInstance(entityInstance),
085                                entityAttribute.getLastDetail().getEntityAttributeName(),
086                                EntityInstanceLogic.getInstance().getEntityRefFromEntityInstance(entityInstanceAttribute));
087                    }
088                } else {
089                    addExecutionError(ExecutionErrors.UnknownEntityRefAttribute.name(), entityRefAttribute);
090                }
091            }
092        }
093        
094        return null;
095    }
096    
097}