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.CreateIndexFieldForm;
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 com.echothree.util.server.persistence.Session;
034import java.util.List;
035import javax.enterprise.context.Dependent;
036
037@Dependent
038public class CreateIndexFieldCommand
039        extends BaseSimpleCommand<CreateIndexFieldForm> {
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.UTILITY.name(), null),
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
048                    new SecurityRoleDefinition(SecurityRoleGroups.IndexField.name(), SecurityRoles.Create.name())
049                    ))
050                ));
051
052        FORM_FIELD_DEFINITIONS = List.of(
053                new FieldDefinition("IndexTypeName", FieldType.ENTITY_NAME, true, null, null),
054                new FieldDefinition("IndexFieldName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
056                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
057                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
058                );
059    }
060    
061    /** Creates a new instance of CreateIndexFieldCommand */
062    public CreateIndexFieldCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var indexControl = Session.getModelController(IndexControl.class);
069        var indexTypeName = form.getIndexTypeName();
070        var indexType = indexControl.getIndexTypeByName(indexTypeName);
071        
072        if(indexType != null) {
073            var indexFieldName = form.getIndexFieldName();
074            var indexField = indexControl.getIndexFieldByName(indexType, indexFieldName);
075            
076            if(indexField == null) {
077                var partyPK = getPartyPK();
078                var isDefault = Boolean.valueOf(form.getIsDefault());
079                var sortOrder = Integer.valueOf(form.getSortOrder());
080                var description = form.getDescription();
081
082                indexField = indexControl.createIndexField(indexType, indexFieldName, isDefault, sortOrder, partyPK);
083
084                if(description != null) {
085                    indexControl.createIndexFieldDescription(indexField, getPreferredLanguage(), description, partyPK);
086                }
087            } else {
088                addExecutionError(ExecutionErrors.DuplicateIndexFieldName.name(), indexTypeName, indexFieldName);
089            }
090        } else {
091            addExecutionError(ExecutionErrors.DuplicateIndexTypeName.name(), indexTypeName);
092        }
093        
094        return null;
095    }
096    
097}