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.model.data.index.server.entity.IndexField;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BaseSingleEntityCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038import javax.inject.Inject;
039
040@Dependent
041public class GetIndexFieldCommand
042        extends BaseSingleEntityCommand<IndexField, GetIndexFieldForm> {
043    
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
051                        new SecurityRoleDefinition(SecurityRoleGroups.IndexField.name(), SecurityRoles.Review.name())
052                ))
053        ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("IndexTypeName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("IndexFieldName", FieldType.ENTITY_NAME, true, null, null)
058        );
059    }
060
061    @Inject
062    IndexControl indexControl;
063
064    @Inject
065    IndexFieldLogic indexFieldLogic;
066
067    @Inject
068    IndexTypeLogic indexTypeLogic;
069
070    /** Creates a new instance of GetIndexFieldCommand */
071    public GetIndexFieldCommand() {
072        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
073    }
074
075    @Override
076    protected IndexField getEntity() {
077        IndexField indexField = null;
078        var indexTypeName = form.getIndexTypeName();
079        var indexType = indexTypeLogic.getIndexTypeByName(this, indexTypeName);
080
081        if(!hasExecutionErrors()) {
082            var indexFieldName = form.getIndexFieldName();
083            indexField = indexFieldLogic.getIndexFieldByName(this, indexType, indexFieldName);
084
085            if(!hasExecutionErrors()) {
086                sendEvent(indexField.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
087            }
088        }
089
090        return indexField;
091    }
092
093    @Override
094    protected BaseResult getResult(IndexField indexField) {
095        var result = IndexResultFactory.getGetIndexFieldResult();
096
097        if(indexField != null) {
098            result.setIndexField(indexControl.getIndexFieldTransfer(getUserVisit(), indexField));
099        }
100
101        return result;
102    }
103    
104}