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