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