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.GetEntityLongRangeForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.common.EntityAttributeTypes;
022import com.echothree.model.data.core.server.entity.EntityLongRange;
023import com.echothree.model.data.user.common.pk.UserVisitPK;
024import com.echothree.util.common.command.BaseResult;
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.server.control.BaseSingleEntityCommand;
029import java.util.List;
030import javax.enterprise.context.RequestScoped;
031
032@RequestScoped
033public class GetEntityLongRangeCommand
034        extends BaseSingleEntityCommand<EntityLongRange, GetEntityLongRangeForm> {
035
036    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
037    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
038    
039    static {
040        FORM_FIELD_DEFINITIONS = List.of(
041                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
042                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, true, null, null),
043                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, true, null, null),
044                new FieldDefinition("EntityLongRangeName", FieldType.ENTITY_NAME, true, null, null)
045        );
046    }
047    
048    /** Creates a new instance of GetEntityLongRangeCommand */
049    public GetEntityLongRangeCommand() {
050        super(null, FORM_FIELD_DEFINITIONS, true);
051    }
052
053
054    @Override
055    protected EntityLongRange getEntity() {
056        EntityLongRange entityLongRange = null;
057        var componentVendorName = form.getComponentVendorName();
058        var componentVendor = componentControl.getComponentVendorByName(componentVendorName);
059
060        if(componentVendor != null) {
061            var entityTypeName = form.getEntityTypeName();
062            var entityType = entityTypeControl.getEntityTypeByName(componentVendor, entityTypeName);
063
064            if(entityType != null) {
065                var entityAttributeName = form.getEntityAttributeName();
066                var entityAttribute = coreControl.getEntityAttributeByName(entityType, entityAttributeName);
067
068                if(entityAttribute != null) {
069                    var entityAttributeType = entityAttribute.getLastDetail().getEntityAttributeType();
070                    var entityAttributeTypeName = entityAttributeType.getEntityAttributeTypeName();
071
072                    if(entityAttributeTypeName.equals(EntityAttributeTypes.LONG.name())) {
073                        var entityLongRangeName = form.getEntityLongRangeName();
074
075                        entityLongRange = coreControl.getEntityLongRangeByName(entityAttribute, entityLongRangeName);
076
077                        if(entityLongRange == null) {
078                            addExecutionError(ExecutionErrors.UnknownEntityLongRangeName.name(), componentVendorName, entityTypeName, entityAttributeName, entityLongRangeName);
079                        }
080                    } else {
081                        addExecutionError(ExecutionErrors.InvalidEntityAttributeType.name(), componentVendorName, entityTypeName, entityAttributeName, entityAttributeTypeName);
082                    }
083                } else {
084                    addExecutionError(ExecutionErrors.UnknownEntityAttributeName.name(), componentVendorName, entityTypeName, entityAttributeName);
085                }
086            } else {
087                addExecutionError(ExecutionErrors.UnknownEntityTypeName.name(), componentVendorName, entityTypeName);
088            }
089        } else {
090            addExecutionError(ExecutionErrors.UnknownComponentVendorName.name(), componentVendorName);
091        }
092
093        return entityLongRange;
094    }
095
096    @Override
097    protected BaseResult getResult(EntityLongRange entityLongRange) {
098        var result = CoreResultFactory.getGetEntityLongRangeResult();
099
100        if(entityLongRange != null) {
101
102            result.setEntityLongRange(coreControl.getEntityLongRangeTransfer(getUserVisit(), entityLongRange, null));
103        }
104
105        return result;
106    }
107
108}