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