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.core.server.command;
018
019import com.echothree.control.user.core.common.form.GetEntityAttributeDescriptionsForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
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 java.util.List;
034import javax.enterprise.context.Dependent;
035
036@Dependent
037public class GetEntityAttributeDescriptionsCommand
038        extends BaseSimpleCommand<GetEntityAttributeDescriptionsForm> {
039    
040    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
041    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
042    
043    static {
044        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
045                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
046                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
047                        new SecurityRoleDefinition(SecurityRoleGroups.EntityAttribute.name(), SecurityRoles.Description.name())
048                        ))
049                ));
050        
051        FORM_FIELD_DEFINITIONS = List.of(
052                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
053                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, true, null, null),
054                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, true, null, null)
055                );
056    }
057    
058    /** Creates a new instance of GetEntityAttributeDescriptionsCommand */
059    public GetEntityAttributeDescriptionsCommand() {
060        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
061    }
062    
063    @Override
064    protected BaseResult execute() {
065        var result = CoreResultFactory.getGetEntityAttributeDescriptionsResult();
066        var componentVendorName = form.getComponentVendorName();
067        var componentVendor = componentControl.getComponentVendorByName(componentVendorName);
068        
069        if(componentVendor != null) {
070            var entityTypeName = form.getEntityTypeName();
071            var entityType = entityTypeControl.getEntityTypeByName(componentVendor, entityTypeName);
072            
073            if(entityType != null) {
074                var entityAttributeName = form.getEntityAttributeName();
075                var entityAttribute = coreControl.getEntityAttributeByName(entityType, entityAttributeName);
076                
077                if(entityAttribute != null) {
078                    var userVisit = getUserVisit();
079                    
080                    result.setEntityAttribute(coreControl.getEntityAttributeTransfer(userVisit, entityAttribute, null));
081                    result.setEntityAttributeDescriptions(coreControl.getEntityAttributeDescriptionTransfersByEntityAttribute(userVisit, entityAttribute, null));
082                } else {
083                    addExecutionError(ExecutionErrors.UnknownEntityAttributeName.name(), entityAttributeName);
084                }
085            } else {
086                addExecutionError(ExecutionErrors.UnknownEntityTypeName.name(), entityTypeName);
087            }
088        } else {
089            addExecutionError(ExecutionErrors.UnknownComponentVendorName.name(), componentVendorName);
090        }
091        
092        return result;
093    }
094    
095}