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.GetEntityAttributeDescriptionForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.party.server.control.PartyControl;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037
038@Dependent
039public class GetEntityAttributeDescriptionCommand
040        extends BaseSimpleCommand<GetEntityAttributeDescriptionForm> {
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(List.of(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.EntityAttribute.name(), SecurityRoles.Description.name())
050                        ))
051                ));
052        
053        FORM_FIELD_DEFINITIONS = List.of(
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 GetEntityAttributeDescriptionCommand */
061    public GetEntityAttributeDescriptionCommand() {
062        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
063    }
064    
065    @Override
066    protected BaseResult execute() {
067        var result = CoreResultFactory.getGetEntityAttributeDescriptionResult();
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 partyControl = Session.getModelController(PartyControl.class);
081                    var languageIsoName = form.getLanguageIsoName();
082                    var language = partyControl.getLanguageByIsoName(languageIsoName);
083
084                    if(language != null) {
085                        var entityAttributeDescription = coreControl.getEntityAttributeDescription(entityAttribute, language);
086
087                        if(entityAttributeDescription != null) {
088                            result.setEntityAttributeDescription(coreControl.getEntityAttributeDescriptionTransfer(getUserVisit(), entityAttributeDescription, null));
089                        } else {
090                            addExecutionError(ExecutionErrors.UnknownEntityAttributeDescription.name(), componentVendorName, entityTypeName, entityAttributeName,
091                                    languageIsoName);
092                        }
093                    } else {
094                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
095                    }
096                } else {
097                    addExecutionError(ExecutionErrors.UnknownEntityAttributeName.name(), entityAttributeName);
098                }
099            } else {
100                addExecutionError(ExecutionErrors.UnknownEntityTypeName.name(), entityTypeName);
101            }
102        } else {
103            addExecutionError(ExecutionErrors.UnknownComponentVendorName.name(), componentVendorName);
104        }
105
106        return result;
107    }
108    
109}