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.SetDefaultSearchSortOrderForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.search.server.control.SearchControl;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.util.common.message.ExecutionErrors;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import com.echothree.util.server.persistence.Session;
034import java.util.List;
035import javax.enterprise.context.Dependent;
036
037@Dependent
038public class SetDefaultSearchSortOrderCommand
039        extends BaseSimpleCommand<SetDefaultSearchSortOrderForm> {
040    
041    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
042    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
043    
044    static {
045        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
046                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
047                    new SecurityRoleDefinition(SecurityRoleGroups.SearchSortOrder.name(), SecurityRoles.Edit.name())
048                    ))
049                ));
050
051        FORM_FIELD_DEFINITIONS = List.of(
052                new FieldDefinition("SearchKindName", FieldType.ENTITY_NAME, true, null, null),
053                new FieldDefinition("SearchSortOrderName", FieldType.ENTITY_NAME, true, null, null)
054                );
055    }
056    
057    /** Creates a new instance of SetDefaultSearchSortOrderCommand */
058    public SetDefaultSearchSortOrderCommand() {
059        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
060    }
061    
062    @Override
063    protected BaseResult execute() {
064        var searchControl = Session.getModelController(SearchControl.class);
065        var searchKindName = form.getSearchKindName();
066        var searchKind = searchControl.getSearchKindByName(searchKindName);
067        
068        if(searchKind != null) {
069            var searchSortOrderName = form.getSearchSortOrderName();
070            var searchSortOrderDetailValue = searchControl.getSearchSortOrderDetailValueByNameForUpdate(searchKind,
071                    searchSortOrderName);
072            
073            if(searchSortOrderDetailValue != null) {
074                searchSortOrderDetailValue.setIsDefault(true);
075                searchControl.updateSearchSortOrderFromValue(searchSortOrderDetailValue, getPartyPK());
076            } else {
077                addExecutionError(ExecutionErrors.UnknownSearchSortOrderName.name(), searchKindName, searchSortOrderName);
078            }
079        } else {
080            addExecutionError(ExecutionErrors.DuplicateSearchKindName.name(), searchKindName);
081        }
082        
083        return null;
084    }
085    
086}