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.GetEntityListItemResultsForm;
020import com.echothree.control.user.search.common.result.SearchResultFactory;
021import com.echothree.model.control.core.server.control.EntityListItemControl;
022import com.echothree.model.control.search.common.SearchKinds;
023import com.echothree.model.control.search.server.control.SearchControl;
024import com.echothree.model.control.search.server.logic.SearchLogic;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import java.util.List;
032import javax.enterprise.context.Dependent;
033import javax.inject.Inject;
034
035@Dependent
036public class GetEntityListItemResultsCommand
037        extends BaseSimpleCommand<GetEntityListItemResultsForm> {
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                new FieldDefinition("SearchTypeName", FieldType.ENTITY_NAME, true, null, null)
045        );
046    }
047
048    @Inject
049    EntityListItemControl entityListItemControl;
050
051    @Inject
052    SearchControl searchControl;
053
054    @Inject
055    SearchLogic searchLogic;
056
057    /** Creates a new instance of GetEntityListItemResultsCommand */
058    public GetEntityListItemResultsCommand() {
059        super(null, FORM_FIELD_DEFINITIONS, true);
060    }
061    
062    @Override
063    protected BaseResult execute() {
064        var result = SearchResultFactory.getGetEntityListItemResultsResult();
065        var searchKind = searchControl.getSearchKindByName(SearchKinds.ENTITY_LIST_ITEM.name());
066        
067        if(searchKind != null) {
068            var searchTypeName = form.getSearchTypeName();
069            var searchType = searchControl.getSearchTypeByName(searchKind, searchTypeName);
070            
071            if(searchType != null) {
072                var userVisit = getUserVisit();
073                var userVisitSearch = searchControl.getUserVisitSearch(userVisit, searchType);
074                
075                if(userVisitSearch != null) {
076                    if(session.hasLimit(com.echothree.model.data.search.server.factory.SearchResultFactory.class)) {
077                        result.setEntityListItemResultCount(searchLogic.countSearchResults(userVisitSearch.getSearch()));
078                    }
079
080                    result.setEntityListItemResults(entityListItemControl.getEntityListItemResultTransfers(userVisit, userVisitSearch));
081                } else {
082                    addExecutionError(ExecutionErrors.UnknownUserVisitSearch.name());
083                }
084            } else {
085                addExecutionError(ExecutionErrors.UnknownSearchTypeName.name(), SearchKinds.ENTITY_LIST_ITEM.name(), searchTypeName);
086            }
087        } else {
088            addExecutionError(ExecutionErrors.UnknownSearchKindName.name(), SearchKinds.ENTITY_LIST_ITEM.name());
089        }
090        
091        return result;
092    }
093}