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.DeleteEntityAppearanceForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.security.common.SecurityRoleGroups;
022import com.echothree.model.control.security.common.SecurityRoles;
023import com.echothree.model.data.core.server.entity.EntityAppearance;
024import com.echothree.model.data.core.server.entity.EntityInstance;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
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.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import java.util.Arrays;
035import java.util.Collections;
036import java.util.List;
037
038public class DeleteEntityAppearanceCommand
039        extends BaseSimpleCommand<DeleteEntityAppearanceForm> {
040    
041    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
042    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
043    
044    static {
045        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
046                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
048                        new SecurityRoleDefinition(SecurityRoleGroups.EntityAppearance.name(), SecurityRoles.Delete.name())
049                        )))
050                )));
051        
052        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
053                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, true, null, null)
054                ));
055    }
056    
057    /** Creates a new instance of DeleteEntityAppearanceCommand */
058    public DeleteEntityAppearanceCommand(UserVisitPK userVisitPK, DeleteEntityAppearanceForm form) {
059        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
060    }
061    
062    @Override
063    protected BaseResult execute() {
064        var coreControl = getCoreControl();
065        String entityRef = form.getEntityRef();
066        EntityInstance entityInstance = coreControl.getEntityInstanceByEntityRef(entityRef);
067
068        if(entityInstance != null) {
069            EntityAppearance entityAppearance = coreControl.getEntityAppearanceForUpdate(entityInstance);
070
071            if(entityAppearance != null) {
072                coreControl.deleteEntityAppearance(entityAppearance, getPartyPK());
073            } else {
074                addExecutionError(ExecutionErrors.UnknownEntityAppearance.name(), entityRef);
075            }
076        } else {
077            addExecutionError(ExecutionErrors.UnknownEntityRef.name(), entityRef);
078        }
079
080        return null;
081    }
082    
083}