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.term.server.command;
018
019import com.echothree.control.user.term.common.form.GetTermsForm;
020import com.echothree.control.user.term.common.result.TermResultFactory;
021import com.echothree.model.control.term.server.control.TermControl;
022import com.echothree.model.data.term.server.entity.Term;
023import com.echothree.model.data.term.server.factory.TermFactory;
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 GetTermsCommand
034        extends BasePaginatedMultipleEntitiesCommand<Term, GetTermsForm> {
035
036    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
037    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
038
039    static {
040        FORM_FIELD_DEFINITIONS = List.of();
041    }
042
043    @Inject
044    TermControl termControl;
045
046    
047    /** Creates a new instance of GetTermsCommand */
048    public GetTermsCommand() {
049        super(null, FORM_FIELD_DEFINITIONS, true);
050    }
051
052    @Override
053    protected void handleForm() {
054        // No form fields.
055    }
056
057    @Override
058    protected Long getTotalEntities() {
059        return termControl.countTerms();
060    }
061
062    @Override
063    protected Collection<Term> getEntities() {
064        return termControl.getTerms();
065    }
066
067    @Override
068    protected BaseResult getResult(Collection<Term> entities) {
069        var result = TermResultFactory.getGetTermsResult();
070
071        if(entities != null) {
072            if(session.hasLimit(TermFactory.class)) {
073                result.setTermCount(getTotalEntities());
074            }
075
076            result.setTerms(termControl.getTermTransfers(getUserVisit(), entities));
077        }
078
079        return result;
080    }
081    
082}