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.GetSearchSortDirectionChoicesForm;
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.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038
039@Dependent
040public class GetSearchSortDirectionChoicesCommand
041        extends BaseSimpleCommand<GetSearchSortDirectionChoicesForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.SearchSortDirection.name(), SecurityRoles.Choices.name())
050                        ))
051                ));
052        
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("SearchKindName", FieldType.ENTITY_NAME, false, null, null),
055                new FieldDefinition("SearchTypeName", FieldType.ENTITY_NAME, false, null, null),
056                new FieldDefinition("DefaultSearchSortDirectionChoice", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
058                );
059    }
060    
061    /** Creates a new instance of GetSearchSortDirectionChoicesCommand */
062    public GetSearchSortDirectionChoicesCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var result = SearchResultFactory.getGetSearchSortDirectionChoicesResult();
069        var searchKindName = form.getSearchKindName();
070        var searchTypeName = form.getSearchTypeName();
071        var parameterCount = (searchKindName == null ? 0 : 1) + (searchTypeName == null ? 0 : 1);
072
073        if(parameterCount == 0 || parameterCount == 2) {
074            var defaultSearchSortDirectionChoice = form.getDefaultSearchSortDirectionChoice();
075            var party = getParty();
076            var searchType = defaultSearchSortDirectionChoice == null && party != null ? SearchLogic.getInstance().getSearchTypeByName(this, searchKindName, searchTypeName) : null;
077
078            if(!hasExecutionErrors()) {
079                var searchControl = Session.getModelController(SearchControl.class);
080                var allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
081
082                if(searchType != null) {
083                    var partySearchTypePreference = searchControl.getPartySearchTypePreference(party, searchType);
084
085                    if(partySearchTypePreference != null) {
086                        var searchSortDirection = partySearchTypePreference.getLastDetail().getSearchSortDirection();
087
088                        if(searchSortDirection != null) {
089                            defaultSearchSortDirectionChoice = searchSortDirection.getLastDetail().getSearchSortDirectionName();
090                        }
091                    }
092                }
093
094                result.setSearchSortDirectionChoices(searchControl.getSearchSortDirectionChoices(defaultSearchSortDirectionChoice, getPreferredLanguage(), allowNullChoice));
095            }
096        } else {
097            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
098        }
099
100        return result;
101     }
102    
103}