001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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;
027
028public abstract class BaseClearResultsCommand<F extends BaseClearResultsForm>
029        extends BaseSimpleCommand<F> {
030    
031    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
032
033    static {
034        FORM_FIELD_DEFINITIONS = List.of(
035                new FieldDefinition("SearchTypeName", FieldType.ENTITY_NAME, true, null, null)
036        );
037    }
038
039    /** Creates a new instance of BaseClearResultsCommand */
040    protected BaseClearResultsCommand(CommandSecurityDefinition COMMAND_SECURITY_DEFINITION) {
041        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
042    }
043    
044    protected BaseResult execute(String searchKindName) {
045        SearchLogic.getInstance().removeUserVisitSearch(this, getUserVisit(),searchKindName, form.getSearchTypeName());
046
047        return null;
048    }
049    
050    @Override
051    protected abstract BaseResult execute();
052    
053}