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.control.user.index.common.result.IndexResultFactory;
021import com.echothree.model.control.index.server.control.IndexControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.index.server.entity.IndexField;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
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 java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class CreateIndexFieldCommand
041        extends BaseSimpleCommand<CreateIndexFieldForm> {
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.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.IndexField.name(), SecurityRoles.Create.name())
051                ))
052        ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("IndexTypeName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("IndexFieldName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
058                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
059                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
060        );
061    }
062
063    @Inject
064    IndexControl indexControl;
065
066    
067    /** Creates a new instance of CreateIndexFieldCommand */
068    public CreateIndexFieldCommand() {
069        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
070    }
071    
072    @Override
073    protected BaseResult execute() {
074        var result = IndexResultFactory.getCreateIndexFieldResult();
075        IndexField indexField = null;
076        var indexTypeName = form.getIndexTypeName();
077        var indexType = indexControl.getIndexTypeByName(indexTypeName);
078        
079        if(indexType != null) {
080            var indexFieldName = form.getIndexFieldName();
081
082            indexField = indexControl.getIndexFieldByName(indexType, indexFieldName);
083            
084            if(indexField == null) {
085                var partyPK = getPartyPK();
086                var isDefault = Boolean.valueOf(form.getIsDefault());
087                var sortOrder = Integer.valueOf(form.getSortOrder());
088                var description = form.getDescription();
089
090                indexField = indexControl.createIndexField(indexType, indexFieldName, isDefault, sortOrder, partyPK);
091
092                if(description != null) {
093                    indexControl.createIndexFieldDescription(indexField, getPreferredLanguage(), description, partyPK);
094                }
095            } else {
096                addExecutionError(ExecutionErrors.DuplicateIndexFieldName.name(), indexTypeName, indexFieldName);
097            }
098        } else {
099            addExecutionError(ExecutionErrors.DuplicateIndexTypeName.name(), indexTypeName);
100        }
101        
102        if(indexField != null) {
103            result.setEntityRef(indexField.getPrimaryKey().getEntityRef());
104            result.setIndexTypeName(indexField.getLastDetail().getIndexType().getLastDetail().getIndexTypeName());
105            result.setIndexFieldName(indexField.getLastDetail().getIndexFieldName());
106        }
107
108        return result;
109    }
110    
111}