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