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.GetEntityLongRangeDescriptionForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.common.EntityAttributeTypes;
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 java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class GetEntityLongRangeDescriptionCommand
041        extends BaseSimpleCommand<GetEntityLongRangeDescriptionForm> {
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.EntityLongRange.name(), SecurityRoles.Description.name())
051                ))
052        ));
053        
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, true, null, null),
057                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("EntityLongRangeName", FieldType.ENTITY_NAME, true, null, null)
059        );
060    }
061
062    @Inject
063    PartyControl partyControl;
064
065    
066    /** Creates a new instance of GetEntityLongRangeDescriptionCommand */
067    public GetEntityLongRangeDescriptionCommand() {
068        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
069    }
070    
071    @Override
072    protected BaseResult execute() {
073        var result = CoreResultFactory.getGetEntityLongRangeDescriptionResult();
074        var componentVendorName = form.getComponentVendorName();
075        var componentVendor = componentControl.getComponentVendorByName(componentVendorName);
076
077        if(componentVendor != null) {
078            var entityTypeName = form.getEntityTypeName();
079            var entityType = entityTypeControl.getEntityTypeByName(componentVendor, entityTypeName);
080
081            if(entityType != null) {
082                var entityAttributeName = form.getEntityAttributeName();
083                var entityAttribute = coreControl.getEntityAttributeByName(entityType, entityAttributeName);
084
085                if(entityAttribute != null) {
086                    var entityAttributeType = entityAttribute.getLastDetail().getEntityAttributeType();
087                    var entityAttributeTypeName = entityAttributeType.getEntityAttributeTypeName();
088
089                    if(entityAttributeTypeName.equals(EntityAttributeTypes.LONG.name())) {
090                        var entityLongRangeName = form.getEntityLongRangeName();
091                        var entityLongRange = coreControl.getEntityLongRangeByName(entityAttribute, entityLongRangeName);
092
093                        if(entityLongRange != null) {
094                            var languageIsoName = form.getLanguageIsoName();
095                            var language = partyControl.getLanguageByIsoName(languageIsoName);
096
097                            if(language != null) {
098                                var entityLongRangeDescription = coreControl.getEntityLongRangeDescription(entityLongRange, language);
099
100                                if(entityLongRangeDescription != null) {
101                                    result.setEntityLongRangeDescription(coreControl.getEntityLongRangeDescriptionTransfer(getUserVisit(), entityLongRangeDescription, null));
102                                } else {
103                                    addExecutionError(ExecutionErrors.UnknownEntityLongRangeDescription.name(), componentVendorName, entityTypeName, entityAttributeName,
104                                            entityLongRangeName, languageIsoName);
105                                }
106                            } else {
107                                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
108                            }
109                        } else {
110                            addExecutionError(ExecutionErrors.UnknownEntityLongRangeName.name(), componentVendorName, entityTypeName, entityAttributeName, entityLongRangeName);
111                        }
112                    } else {
113                        addExecutionError(ExecutionErrors.InvalidEntityAttributeType.name(), componentVendorName, entityTypeName, entityAttributeName, entityAttributeTypeName);
114                    }
115                } else {
116                    addExecutionError(ExecutionErrors.UnknownEntityAttributeName.name(), componentVendorName, entityTypeName, entityAttributeName);
117                }
118            } else {
119                addExecutionError(ExecutionErrors.UnknownEntityTypeName.name(), componentVendorName, entityTypeName);
120            }
121        } else {
122            addExecutionError(ExecutionErrors.UnknownComponentVendorName.name(), componentVendorName);
123        }
124
125        return result;
126    }
127    
128}