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.index.server.command;
018
019import com.echothree.control.user.index.common.form.SetDefaultIndexFieldForm;
020import com.echothree.model.control.index.server.control.IndexControl;
021import com.echothree.model.control.party.common.PartyTypes;
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 java.util.List;
034import javax.enterprise.context.Dependent;
035import javax.inject.Inject;
036
037@Dependent
038public class SetDefaultIndexFieldCommand
039        extends BaseSimpleCommand<SetDefaultIndexFieldForm> {
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.IndexField.name(), SecurityRoles.Edit.name())
048                ))
049        ));
050
051        FORM_FIELD_DEFINITIONS = List.of(
052                new FieldDefinition("IndexTypeName", FieldType.ENTITY_NAME, true, null, null),
053                new FieldDefinition("IndexFieldName", FieldType.ENTITY_NAME, true, null, null)
054        );
055    }
056
057    @Inject
058    IndexControl indexControl;
059
060    
061    /** Creates a new instance of SetDefaultIndexFieldCommand */
062    public SetDefaultIndexFieldCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var indexTypeName = form.getIndexTypeName();
069        var indexType = indexControl.getIndexTypeByName(indexTypeName);
070        
071        if(indexType != null) {
072            var indexFieldName = form.getIndexFieldName();
073            var indexFieldDetailValue = indexControl.getIndexFieldDetailValueByNameForUpdate(indexType,
074                    indexFieldName);
075            
076            if(indexFieldDetailValue != null) {
077                indexFieldDetailValue.setIsDefault(true);
078                indexControl.updateIndexFieldFromValue(indexFieldDetailValue, getPartyPK());
079            } else {
080                addExecutionError(ExecutionErrors.UnknownIndexFieldName.name(), indexTypeName, indexFieldName);
081            }
082        } else {
083            addExecutionError(ExecutionErrors.DuplicateIndexTypeName.name(), indexTypeName);
084        }
085        
086        return null;
087    }
088    
089}