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.search.server.command;
018
019import com.echothree.control.user.search.common.form.BaseCountResultsForm;
020import com.echothree.control.user.search.common.result.BaseCountResultsResult;
021import com.echothree.model.control.search.server.logic.SearchLogic;
022import com.echothree.model.data.user.common.pk.UserVisitPK;
023import com.echothree.util.common.validation.FieldDefinition;
024import com.echothree.util.common.validation.FieldType;
025import com.echothree.util.common.command.BaseResult;
026import com.echothree.util.server.control.BaseSimpleCommand;
027import com.echothree.util.server.control.CommandSecurityDefinition;
028import java.util.Arrays;
029import java.util.Collections;
030import java.util.List;
031
032public abstract class BaseCountResultsCommand<F extends BaseCountResultsForm, R extends BaseCountResultsResult>
033        extends BaseSimpleCommand<F> {
034    
035    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
036
037    static {
038        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
039                new FieldDefinition("SearchTypeName", FieldType.ENTITY_NAME, true, null, null)
040                ));
041    }
042
043    /** Creates a new instance of BaseCountResultsCommand */
044    protected BaseCountResultsCommand(UserVisitPK userVisitPK, F form, CommandSecurityDefinition COMMAND_SECURITY_DEFINITION) {
045        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
046    }
047    
048    protected BaseResult execute(String searchKindName, BaseCountResultsResult result) {
049        result.setCount(SearchLogic.getInstance().countUserVisitSearchResults(this, getUserVisit(), searchKindName, form.getSearchTypeName()));
050
051        return result;
052    }
053    
054    @Override
055    protected abstract BaseResult execute();
056    
057}