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 java.util.List;
032import javax.enterprise.context.Dependent;
033import javax.inject.Inject;
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    @Inject
049    ContentControl contentControl;
050
051    @Inject
052    ForumControl forumControl;
053
054    
055    /** Creates a new instance of GetContentForumCommand */
056    public GetContentForumCommand() {
057        super(null, FORM_FIELD_DEFINITIONS, true);
058    }
059    
060    @Override
061    protected ContentForum getEntity() {
062        var contentCollectionName = form.getContentCollectionName();
063        var contentCollection = contentControl.getContentCollectionByName(contentCollectionName);
064        ContentForum contentForum = null;
065        
066        if(contentCollection != null) {
067            var forumName = form.getForumName();
068            var forum = forumControl.getForumByName(forumName);
069            
070            if(forum != null) {
071                contentForum = contentControl.getContentForum(contentCollection, forum);
072                
073                if(contentForum != null) {
074                    sendEvent(contentForum.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
075                } else {
076                    addExecutionError(ExecutionErrors.UnknownContentForum.name());
077                }
078            } else {
079                addExecutionError(ExecutionErrors.UnknownForumName.name(), forumName);
080            }
081        } else {
082            addExecutionError(ExecutionErrors.UnknownContentCollectionName.name(), contentCollectionName);
083        }
084        
085        return contentForum;
086    }
087    
088    @Override
089    protected BaseResult getResult(ContentForum contentForum) {
090        var result = ContentResultFactory.getGetContentForumResult();
091                
092        if(contentForum != null) {
093        result.setContentForum(contentControl.getContentForumTransfer(getUserVisit(), contentForum));
094        }
095        
096        return result;
097    }
098    
099}