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.DeleteEntityAttributeForm;
020import com.echothree.model.control.core.server.logic.EntityAttributeLogic;
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.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.control.SecurityRoleDefinition;
033import java.util.List;
034
035public class DeleteEntityAttributeCommand
036        extends BaseSimpleCommand<DeleteEntityAttributeForm> {
037    
038    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
039    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
040    
041    static {
042        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
043                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
044                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
045                        new SecurityRoleDefinition(SecurityRoleGroups.EntityAttribute.name(), SecurityRoles.Delete.name())
046                ))
047        ));
048        
049        FORM_FIELD_DEFINITIONS = List.of(
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("ComponentVendorName", FieldType.ENTITY_NAME, false, null, null),
055                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, false, null, null),
056                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, false, null, null)
057        );
058    }
059    
060    /** Creates a new instance of DeleteEntityAttributeCommand */
061    public DeleteEntityAttributeCommand(UserVisitPK userVisitPK, DeleteEntityAttributeForm form) {
062        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
063    }
064    
065    @Override
066    protected BaseResult execute() {
067        var entityAttribute = EntityAttributeLogic.getInstance().getEntityAttributeByUniversalSpecForUpdate(this, form);
068
069        if(!hasExecutionErrors()) {
070            EntityAttributeLogic.getInstance().deleteEntityAttribute(this, entityAttribute, getPartyPK());
071        }
072
073        return null;
074    }
075    
076}