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.GetIndexFieldForm;
020import com.echothree.control.user.index.common.result.IndexResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
022import com.echothree.model.control.index.server.control.IndexControl;
023import com.echothree.model.control.index.server.logic.IndexFieldLogic;
024import com.echothree.model.control.index.server.logic.IndexTypeLogic;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.util.common.command.BaseResult;
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 GetIndexFieldCommand
041        extends BaseSimpleCommand<GetIndexFieldForm> {
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.Review.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        );
058    }
059    
060    /** Creates a new instance of GetIndexFieldCommand */
061    public GetIndexFieldCommand() {
062        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
063    }
064    
065    @Inject
066    IndexControl indexControl;
067
068    @Inject
069    IndexFieldLogic indexFieldLogic;
070
071    @Inject
072    IndexTypeLogic indexTypeLogic;
073
074    @Override
075    protected BaseResult execute() {
076        var result = IndexResultFactory.getGetIndexFieldResult();
077        var indexTypeName = form.getIndexTypeName();
078        var indexType = indexTypeLogic.getIndexTypeByName(this, indexTypeName);
079        
080        if(!hasExecutionErrors()) {
081            var indexFieldName = form.getIndexFieldName();
082            var indexField = indexFieldLogic.getIndexFieldByName(this, indexType, indexFieldName);
083            
084            if(!hasExecutionErrors()) {
085                result.setIndexField(indexControl.getIndexFieldTransfer(getUserVisit(), indexField));
086                
087                sendEvent(indexField.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
088            }
089        }
090        
091        return result;
092    }
093    
094}