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.GetEntityAttributeResultsForm;
020import com.echothree.control.user.search.common.result.SearchResultFactory;
021import com.echothree.model.control.core.server.control.EntityAttributeControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.search.common.SearchKinds;
024import com.echothree.model.control.search.server.control.SearchControl;
025import com.echothree.model.control.search.server.logic.SearchLogic;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BaseSimpleCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import com.echothree.util.server.persistence.Session;
038import java.util.List;
039import javax.enterprise.context.RequestScoped;
040
041@RequestScoped
042public class GetEntityAttributeResultsCommand
043        extends BaseSimpleCommand<GetEntityAttributeResultsForm> {
044
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.EntityAttribute.name(), SecurityRoles.Search.name())
053                ))
054        ));
055
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("SearchTypeName", FieldType.ENTITY_NAME, true, null, null)
058        );
059    }
060
061    /** Creates a new instance of GetEntityAttributeResultsCommand */
062    public GetEntityAttributeResultsCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var result = SearchResultFactory.getGetEntityAttributeResultsResult();
069        var searchControl = Session.getModelController(SearchControl.class);
070        var searchKind = searchControl.getSearchKindByName(SearchKinds.ENTITY_ATTRIBUTE.name());
071        
072        if(searchKind != null) {
073            var searchTypeName = form.getSearchTypeName();
074            var searchType = searchControl.getSearchTypeByName(searchKind, searchTypeName);
075            
076            if(searchType != null) {
077                var userVisit = getUserVisit();
078                var userVisitSearch = searchControl.getUserVisitSearch(userVisit, searchType);
079                
080                if(userVisitSearch != null) {
081                    var entityAttributeControl = Session.getModelController(EntityAttributeControl.class);
082
083                    if(session.hasLimit(com.echothree.model.data.search.server.factory.SearchResultFactory.class)) {
084                        result.setEntityAttributeResultCount(SearchLogic.getInstance().countSearchResults(userVisitSearch.getSearch()));
085                    }
086
087                    result.setEntityAttributeResults(entityAttributeControl.getEntityAttributeResultTransfers(userVisit, userVisitSearch));
088                } else {
089                    addExecutionError(ExecutionErrors.UnknownUserVisitSearch.name());
090                }
091            } else {
092                addExecutionError(ExecutionErrors.UnknownSearchTypeName.name(), SearchKinds.ENTITY_ATTRIBUTE.name(), searchTypeName);
093            }
094        } else {
095            addExecutionError(ExecutionErrors.UnknownSearchKindName.name(), SearchKinds.ENTITY_ATTRIBUTE.name());
096        }
097        
098        return result;
099    }
100}