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.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.model.control.forum.server.control.ForumControl;
022import com.echothree.model.data.forum.server.entity.ForumGroup;
023import com.echothree.model.data.forum.server.factory.ForumGroupFactory;
024import com.echothree.util.common.command.BaseResult;
025import com.echothree.util.common.validation.FieldDefinition;
026import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
027import java.util.Collection;
028import java.util.List;
029import javax.enterprise.context.Dependent;
030import javax.inject.Inject;
031
032@Dependent
033public class GetForumGroupsCommand
034        extends BasePaginatedMultipleEntitiesCommand<ForumGroup, GetForumGroupsForm> {
035
036    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
037
038    static {
039        FORM_FIELD_DEFINITIONS = List.of();
040    }
041
042    @Inject
043    ForumControl forumControl;
044
045    /** Creates a new instance of GetForumGroupsCommand */
046    public GetForumGroupsCommand() {
047        super(null, FORM_FIELD_DEFINITIONS, true);
048    }
049
050    @Override
051    protected void handleForm() {
052        // No form fields.
053    }
054
055    @Override
056    protected Long getTotalEntities() {
057        return forumControl.countForumGroups();
058    }
059
060    @Override
061    protected Collection<ForumGroup> getEntities() {
062        return forumControl.getForumGroups();
063    }
064
065    @Override
066    protected BaseResult getResult(Collection<ForumGroup> entities) {
067        var result = ForumResultFactory.getGetForumGroupsResult();
068
069        if(entities != null) {
070            if(session.hasLimit(ForumGroupFactory.class)) {
071                result.setForumGroupCount(getTotalEntities());
072            }
073
074            result.setForumGroups(forumControl.getForumGroupTransfers(getUserVisit(), entities));
075        }
076
077        return result;
078    }
079
080}