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.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.Arrays;
036import java.util.Collections;
037import java.util.List;
038import javax.enterprise.context.RequestScoped;
039
040@RequestScoped
041public class GetEntityAttributeDescriptionCommand
042        extends BaseSimpleCommand<GetEntityAttributeDescriptionForm> {
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(Collections.unmodifiableList(Arrays.asList(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
051                        new SecurityRoleDefinition(SecurityRoleGroups.EntityAttribute.name(), SecurityRoles.Description.name())
052                        )))
053                )));
054        
055        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
056                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, true, null, null),
058                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, true, null, null)
059                ));
060    }
061    
062    /** Creates a new instance of GetEntityAttributeDescriptionCommand */
063    public GetEntityAttributeDescriptionCommand() {
064        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var result = CoreResultFactory.getGetEntityAttributeDescriptionResult();
070        var componentVendorName = form.getComponentVendorName();
071        var componentVendor = componentControl.getComponentVendorByName(componentVendorName);
072
073        if(componentVendor != null) {
074            var entityTypeName = form.getEntityTypeName();
075            var entityType = entityTypeControl.getEntityTypeByName(componentVendor, entityTypeName);
076
077            if(entityType != null) {
078                var entityAttributeName = form.getEntityAttributeName();
079                var entityAttribute = coreControl.getEntityAttributeByName(entityType, entityAttributeName);
080
081                if(entityAttribute != null) {
082                    var partyControl = Session.getModelController(PartyControl.class);
083                    var languageIsoName = form.getLanguageIsoName();
084                    var language = partyControl.getLanguageByIsoName(languageIsoName);
085
086                    if(language != null) {
087                        var entityAttributeDescription = coreControl.getEntityAttributeDescription(entityAttribute, language);
088
089                        if(entityAttributeDescription != null) {
090                            result.setEntityAttributeDescription(coreControl.getEntityAttributeDescriptionTransfer(getUserVisit(), entityAttributeDescription, null));
091                        } else {
092                            addExecutionError(ExecutionErrors.UnknownEntityAttributeDescription.name(), componentVendorName, entityTypeName, entityAttributeName,
093                                    languageIsoName);
094                        }
095                    } else {
096                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
097                    }
098                } else {
099                    addExecutionError(ExecutionErrors.UnknownEntityAttributeName.name(), entityAttributeName);
100                }
101            } else {
102                addExecutionError(ExecutionErrors.UnknownEntityTypeName.name(), entityTypeName);
103            }
104        } else {
105            addExecutionError(ExecutionErrors.UnknownComponentVendorName.name(), componentVendorName);
106        }
107
108        return result;
109    }
110    
111}