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.GetEntityIntegerRangeDescriptionsForm;
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.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 java.util.List;
035import javax.enterprise.context.Dependent;
036
037@Dependent
038public class GetEntityIntegerRangeDescriptionsCommand
039        extends BaseSimpleCommand<GetEntityIntegerRangeDescriptionsForm> {
040    
041    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
042    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
043    
044    static {
045        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
046                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
048                        new SecurityRoleDefinition(SecurityRoleGroups.EntityIntegerRange.name(), SecurityRoles.Description.name())
049                        ))
050                ));
051        
052        FORM_FIELD_DEFINITIONS = List.of(
053                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
054                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, true, null, null),
055                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("EntityIntegerRangeName", FieldType.ENTITY_NAME, true, null, null)
057                );
058    }
059    
060    /** Creates a new instance of GetEntityIntegerRangeDescriptionsCommand */
061    public GetEntityIntegerRangeDescriptionsCommand() {
062        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
063    }
064    
065    @Override
066    protected BaseResult execute() {
067        var result = CoreResultFactory.getGetEntityIntegerRangeDescriptionsResult();
068        var componentVendorName = form.getComponentVendorName();
069        var componentVendor = componentControl.getComponentVendorByName(componentVendorName);
070        
071        if(componentVendor != null) {
072            var entityTypeName = form.getEntityTypeName();
073            var entityType = entityTypeControl.getEntityTypeByName(componentVendor, entityTypeName);
074            
075            if(entityType != null) {
076                var entityAttributeName = form.getEntityAttributeName();
077                var entityAttribute = coreControl.getEntityAttributeByName(entityType, entityAttributeName);
078                
079                if(entityAttribute != null) {
080                    var entityAttributeType = entityAttribute.getLastDetail().getEntityAttributeType();
081                    var entityAttributeTypeName = entityAttributeType.getEntityAttributeTypeName();
082                    
083                    if(entityAttributeTypeName.equals(EntityAttributeTypes.INTEGER.name())) {
084                        var entityIntegerRangeName = form.getEntityIntegerRangeName();
085                        var entityIntegerRange = coreControl.getEntityIntegerRangeByName(entityAttribute, entityIntegerRangeName);
086                        
087                        if(entityIntegerRange != null) {
088                            var userVisit = getUserVisit();
089                            
090                            result.setEntityIntegerRange(coreControl.getEntityIntegerRangeTransfer(userVisit, entityIntegerRange, null));
091                            result.setEntityIntegerRangeDescriptions(coreControl.getEntityIntegerRangeDescriptionTransfersByEntityIntegerRange(userVisit, entityIntegerRange, null));
092                        } else {
093                            addExecutionError(ExecutionErrors.UnknownEntityIntegerRangeName.name(), componentVendorName, entityTypeName, entityAttributeName, entityIntegerRangeName);
094                        }
095                    } else {
096                        addExecutionError(ExecutionErrors.InvalidEntityAttributeType.name(), componentVendorName, entityTypeName, entityAttributeName, entityAttributeTypeName);
097                    }
098                } else {
099                    addExecutionError(ExecutionErrors.UnknownEntityAttributeName.name(), componentVendorName, entityTypeName, entityAttributeName);
100                }
101            } else {
102                addExecutionError(ExecutionErrors.UnknownEntityTypeName.name(), componentVendorName, entityTypeName);
103            }
104        } else {
105            addExecutionError(ExecutionErrors.UnknownComponentVendorName.name(), componentVendorName);
106        }
107        
108        return result;
109    }
110    
111}