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.GetForumDescriptionsForm;
020import com.echothree.control.user.forum.common.result.ForumResultFactory;
021import com.echothree.control.user.forum.common.result.GetForumDescriptionsResult;
022import com.echothree.model.control.forum.common.ForumConstants;
023import com.echothree.model.control.forum.server.control.ForumControl;
024import com.echothree.model.control.forum.server.logic.ForumLogic;
025import com.echothree.model.data.forum.server.entity.Forum;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.persistence.Session;
033import java.util.Arrays;
034import java.util.Collections;
035import java.util.List;
036
037public class GetForumDescriptionsCommand
038        extends BaseSimpleCommand<GetForumDescriptionsForm> {
039    
040    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
041    
042    static {
043        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
044            new FieldDefinition("ForumName", FieldType.ENTITY_NAME, true, null, null)
045        ));
046    }
047    
048    /** Creates a new instance of GetForumDescriptionsCommand */
049    public GetForumDescriptionsCommand(UserVisitPK userVisitPK, GetForumDescriptionsForm form) {
050        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
051    }
052    
053    @Override
054    protected BaseResult execute() {
055        var forumControl = Session.getModelController(ForumControl.class);
056        GetForumDescriptionsResult result = ForumResultFactory.getGetForumDescriptionsResult();
057        String forumName = form.getForumName();
058        Forum forum = forumControl.getForumByName(forumName);
059        
060        if(forum != null) {
061            if(ForumLogic.getInstance().isForumRoleTypePermitted(this, forum, getParty(), ForumConstants.ForumRoleType_READER)) {
062                result.setForum(forumControl.getForumTransfer(getUserVisit(), forum));
063                result.setForumDescriptions(forumControl.getForumDescriptionTransfersByForum(getUserVisit(), forum));
064            } else {
065                addExecutionError(ExecutionErrors.MissingRequiredForumRoleType.name(), ForumConstants.ForumRoleType_READER);
066            }
067        } else {
068            addExecutionError(ExecutionErrors.UnknownForumName.name(), forumName);
069        }
070        
071        return result;
072    }
073    
074}