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