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