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.forum.server.command;
018
019import com.echothree.control.user.forum.common.form.DeleteForumGroupForm;
020import com.echothree.model.control.forum.server.control.ForumControl;
021import com.echothree.model.data.forum.server.entity.ForumGroup;
022import com.echothree.model.data.user.common.pk.UserVisitPK;
023import com.echothree.util.common.message.ExecutionErrors;
024import com.echothree.util.common.validation.FieldDefinition;
025import com.echothree.util.common.validation.FieldType;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.server.control.BaseSimpleCommand;
028import com.echothree.util.server.persistence.Session;
029import java.util.Arrays;
030import java.util.Collections;
031import java.util.List;
032
033public class DeleteForumGroupCommand
034        extends BaseSimpleCommand<DeleteForumGroupForm> {
035    
036    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
037    
038    static {
039        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
040                new FieldDefinition("ForumGroupName", FieldType.ENTITY_NAME, true, null, null)
041                ));
042    }
043    
044    /** Creates a new instance of DeleteForumGroupCommand */
045    public DeleteForumGroupCommand(UserVisitPK userVisitPK, DeleteForumGroupForm form) {
046        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, false);
047    }
048    
049    @Override
050    protected BaseResult execute() {
051        var forumControl = Session.getModelController(ForumControl.class);
052        String forumGroupName = form.getForumGroupName();
053        ForumGroup forumGroup = forumControl.getForumGroupByNameForUpdate(forumGroupName);
054        
055        if(forumGroup != null) {
056            forumControl.deleteForumGroup(forumGroup, getPartyPK());
057        } else {
058            addExecutionError(ExecutionErrors.UnknownForumGroupName.name(), forumGroupName);
059        }
060        
061        return null;
062    }
063    
064}