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.content.server.command;
018
019import com.echothree.control.user.content.common.form.GetContentForumForm;
020import com.echothree.control.user.content.common.result.ContentResultFactory;
021import com.echothree.model.control.content.server.control.ContentControl;
022import com.echothree.model.control.core.common.EventTypes;
023import com.echothree.model.control.forum.server.control.ForumControl;
024import com.echothree.model.data.content.server.entity.ContentForum;
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.BaseSingleEntityCommand;
031import com.echothree.util.server.persistence.Session;
032import java.util.List;
033import javax.enterprise.context.Dependent;
034
035@Dependent
036public class GetContentForumCommand
037        extends BaseSingleEntityCommand<ContentForum, GetContentForumForm> {
038    
039    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
040    
041    static {
042        FORM_FIELD_DEFINITIONS = List.of(
043                new FieldDefinition("ContentCollectionName", FieldType.ENTITY_NAME, true, null, null),
044                new FieldDefinition("ContentForumName", FieldType.ENTITY_NAME, true, null, null)
045                );
046    }
047    
048    /** Creates a new instance of GetContentForumCommand */
049    public GetContentForumCommand() {
050        super(null, FORM_FIELD_DEFINITIONS, true);
051    }
052    
053    @Override
054    protected ContentForum getEntity() {
055        var contentControl = Session.getModelController(ContentControl.class);
056        var contentCollectionName = form.getContentCollectionName();
057        var contentCollection = contentControl.getContentCollectionByName(contentCollectionName);
058        ContentForum contentForum = null;
059        
060        if(contentCollection != null) {
061            var forumControl = Session.getModelController(ForumControl.class);
062            var forumName = form.getForumName();
063            var forum = forumControl.getForumByName(forumName);
064            
065            if(forum != null) {
066                contentForum = contentControl.getContentForum(contentCollection, forum);
067                
068                if(contentForum != null) {
069                    sendEvent(contentForum.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
070                } else {
071                    addExecutionError(ExecutionErrors.UnknownContentForum.name());
072                }
073            } else {
074                addExecutionError(ExecutionErrors.UnknownForumName.name(), forumName);
075            }
076        } else {
077            addExecutionError(ExecutionErrors.UnknownContentCollectionName.name(), contentCollectionName);
078        }
079        
080        return contentForum;
081    }
082    
083    @Override
084    protected BaseResult getResult(ContentForum contentForum) {
085        var result = ContentResultFactory.getGetContentForumResult();
086                
087        if(contentForum != null) {
088        var contentControl = Session.getModelController(ContentControl.class);
089
090        result.setContentForum(contentControl.getContentForumTransfer(getUserVisit(), contentForum));
091        }
092        
093        return result;
094    }
095    
096}