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.forum.server.command;
018
019import com.echothree.control.user.forum.common.form.GetForumGroupsForm;
020import com.echothree.control.user.forum.common.result.ForumResultFactory;
021import com.echothree.control.user.forum.common.result.GetForumGroupsResult;
022import com.echothree.model.control.forum.server.control.ForumControl;
023import com.echothree.model.data.forum.server.factory.ForumGroupFactory;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.util.common.validation.FieldDefinition;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.server.control.BaseSimpleCommand;
028import com.echothree.util.server.persistence.Session;
029import java.util.Arrays;
030import java.util.Collections;
031import java.util.List;
032
033public class GetForumGroupsCommand
034        extends BaseSimpleCommand<GetForumGroupsForm> {
035    
036    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
037
038    static {
039        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
040                ));
041    }
042
043    /** Creates a new instance of GetForumGroupsCommand */
044    public GetForumGroupsCommand(UserVisitPK userVisitPK, GetForumGroupsForm form) {
045        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
046    }
047    
048    @Override
049    protected BaseResult execute() {
050        var forumControl = Session.getModelController(ForumControl.class);
051        GetForumGroupsResult result = ForumResultFactory.getGetForumGroupsResult();
052        
053        if(session.hasLimit(ForumGroupFactory.class)) {
054            result.setForumGroupCount(forumControl.countForumGroups());
055        }
056
057        result.setForumGroups(forumControl.getForumGroupTransfers(getUserVisit()));
058        
059        return result;
060    }
061    
062}