001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.model.control.forum.common.ForumConstants;
022import com.echothree.model.control.forum.server.control.ForumControl;
023import com.echothree.model.control.forum.server.logic.ForumRoleTypeLogic;
024import com.echothree.util.common.message.ExecutionErrors;
025import com.echothree.util.common.validation.FieldDefinition;
026import com.echothree.util.common.validation.FieldType;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.server.control.BaseSimpleCommand;
029import java.util.List;
030import javax.enterprise.context.Dependent;
031import javax.inject.Inject;
032
033@Dependent
034public class GetForumDescriptionsCommand
035        extends BaseSimpleCommand<GetForumDescriptionsForm> {
036    
037    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
038    
039    static {
040        FORM_FIELD_DEFINITIONS = List.of(
041                new FieldDefinition("ForumName", FieldType.ENTITY_NAME, true, null, null)
042        );
043    }
044
045    @Inject
046    ForumControl forumControl;
047
048    @Inject
049    ForumRoleTypeLogic forumRoleTypeLogic;
050
051    
052    /** Creates a new instance of GetForumDescriptionsCommand */
053    public GetForumDescriptionsCommand() {
054        super(null, FORM_FIELD_DEFINITIONS, true);
055    }
056    
057    @Override
058    protected BaseResult execute() {
059        var result = ForumResultFactory.getGetForumDescriptionsResult();
060        var forumName = form.getForumName();
061        var forum = forumControl.getForumByName(forumName);
062        
063        if(forum != null) {
064            if(forumRoleTypeLogic.isForumRoleTypePermitted(this, forum, getParty(), ForumConstants.ForumRoleType_READER)) {
065                result.setForum(forumControl.getForumTransfer(getUserVisit(), forum));
066                result.setForumDescriptions(forumControl.getForumDescriptionTransfersByForum(getUserVisit(), forum));
067            } else {
068                addExecutionError(ExecutionErrors.MissingRequiredForumRoleType.name(), ForumConstants.ForumRoleType_READER);
069            }
070        } else {
071            addExecutionError(ExecutionErrors.UnknownForumName.name(), forumName);
072        }
073        
074        return result;
075    }
076    
077}