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.GetSearchSortOrderChoicesForm;
020import com.echothree.control.user.search.common.result.SearchResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.search.server.control.SearchControl;
023import com.echothree.model.control.search.server.logic.SearchLogic;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import java.util.List;
035import javax.enterprise.context.Dependent;
036import javax.inject.Inject;
037
038@Dependent
039public class GetSearchSortOrderChoicesCommand
040        extends BaseSimpleCommand<GetSearchSortOrderChoicesForm> {
041    
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
048                        new SecurityRoleDefinition(SecurityRoleGroups.SearchSortOrder.name(), SecurityRoles.Choices.name())
049                ))
050        ));
051
052        FORM_FIELD_DEFINITIONS = List.of(
053                new FieldDefinition("SearchKindName", FieldType.ENTITY_NAME, true, null, null),
054                new FieldDefinition("SearchTypeName", FieldType.ENTITY_NAME, false, null, null),
055                new FieldDefinition("DefaultSearchSortOrderChoice", FieldType.ENTITY_NAME, false, null, null),
056                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
057        );
058    }
059
060    @Inject
061    SearchControl searchControl;
062
063    @Inject
064    SearchLogic searchLogic;
065
066    
067    /** Creates a new instance of GetSearchSortOrderChoicesCommand */
068    public GetSearchSortOrderChoicesCommand() {
069        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
070    }
071    
072    @Override
073    protected BaseResult execute() {
074        var result = SearchResultFactory.getGetSearchSortOrderChoicesResult();
075        var searchKindName = form.getSearchKindName();
076        var searchKind = searchLogic.getSearchKindByName(this, searchKindName);
077        
078        if(!hasExecutionErrors()) {
079            var defaultSearchSortOrderChoice = form.getDefaultSearchSortOrderChoice();
080            var party = getParty();
081            var searchTypeName = form.getSearchTypeName();
082            var searchType = searchTypeName != null && defaultSearchSortOrderChoice == null && party != null ? searchLogic.getSearchTypeByName(this, searchKind, searchTypeName) : null;
083            
084            if(!hasExecutionErrors()) {
085                var allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
086
087                if(searchType != null) {
088                    var partySearchTypePreference = searchControl.getPartySearchTypePreference(party, searchType);
089                    
090                    if(partySearchTypePreference != null) {
091                        var searchSortOrder = partySearchTypePreference.getLastDetail().getSearchSortOrder();
092                        
093                        if(searchSortOrder != null) {
094                            defaultSearchSortOrderChoice = searchSortOrder.getLastDetail().getSearchSortOrderName();
095                        }
096                    }
097                }
098                
099                result.setSearchSortOrderChoices(searchControl.getSearchSortOrderChoices(defaultSearchSortOrderChoice, getPreferredLanguage(), allowNullChoice,
100                        searchKind));
101            }
102        }
103        
104        return result;
105    }
106    
107}