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.GetIndexFieldDescriptionForm;
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.party.server.control.PartyControl;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
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 com.echothree.util.server.persistence.Session;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038
039@Dependent
040public class GetIndexFieldDescriptionCommand
041        extends BaseSimpleCommand<GetIndexFieldDescriptionForm> {
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.Description.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("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
058                );
059    }
060    
061    /** Creates a new instance of GetIndexFieldDescriptionCommand */
062    public GetIndexFieldDescriptionCommand() {
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 result = IndexResultFactory.getGetIndexFieldDescriptionResult();
070        var indexTypeName = form.getIndexTypeName();
071        var indexType = indexControl.getIndexTypeByName(indexTypeName);
072
073        if(indexType != null) {
074            var indexFieldName = form.getIndexFieldName();
075            var indexField = indexControl.getIndexFieldByName(indexType, indexFieldName);
076
077            if(indexField != null) {
078                var partyControl = Session.getModelController(PartyControl.class);
079                var languageIsoName = form.getLanguageIsoName();
080                var language = partyControl.getLanguageByIsoName(languageIsoName);
081
082                if(language != null) {
083                    var indexFieldDescription = indexControl.getIndexFieldDescription(indexField, language);
084
085                    if(indexFieldDescription != null) {
086                        result.setIndexFieldDescription(indexControl.getIndexFieldDescriptionTransfer(getUserVisit(), indexFieldDescription));
087                    } else {
088                        addExecutionError(ExecutionErrors.UnknownIndexFieldDescription.name(), indexTypeName, indexFieldName, languageIsoName);
089                    }
090                } else {
091                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
092                }
093            } else {
094                addExecutionError(ExecutionErrors.UnknownIndexFieldName.name(), indexTypeName, indexFieldName);
095            }
096        } else {
097            addExecutionError(ExecutionErrors.UnknownIndexTypeName.name(), indexTypeName);
098        }
099        
100        return result;
101    }
102    
103}