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