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