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.GetEntityLongRangeChoicesForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.common.EntityAttributeTypes;
022import com.echothree.model.control.core.server.control.EntityInstanceControl;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.core.server.entity.EntityType;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BaseSimpleCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import com.echothree.util.server.persistence.Session;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039
040@Dependent
041public class GetEntityLongRangeChoicesCommand
042        extends BaseSimpleCommand<GetEntityLongRangeChoicesForm> {
043    
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.EntityLongRange.name(), SecurityRoles.Choices.name())
051                        ))
052                ));
053        
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
056                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, false, null, null),
058                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, true, null, null)
059                );
060    }
061    
062    /** Creates a new instance of GetEntityLongRangeChoicesCommand */
063    public GetEntityLongRangeChoicesCommand() {
064        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var result = CoreResultFactory.getGetEntityLongRangeChoicesResult();
070        var entityRef = form.getEntityRef();
071        var componentVendorName = form.getComponentVendorName();
072        var entityTypeName = form.getEntityTypeName();
073        var parameterCount = (entityRef != null && componentVendorName == null && entityTypeName == null? 1: 0)
074                + (entityRef == null && componentVendorName != null && entityTypeName != null? 1: 0);
075        
076        if(parameterCount == 1) {
077            var entityInstanceControl = Session.getModelController(EntityInstanceControl.class);
078            EntityType entityType = null;
079            
080            if(entityRef == null) {
081                var componentVendor = componentControl.getComponentVendorByName(componentVendorName);
082                
083                if(componentVendor != null) {
084                    entityType = entityTypeControl.getEntityTypeByName(componentVendor, entityTypeName);
085                    
086                    if(entityType == null) {
087                        addExecutionError(ExecutionErrors.UnknownEntityTypeName.name(), componentVendorName, entityTypeName);
088                    }
089                } else {
090                    addExecutionError(ExecutionErrors.UnknownComponentVendorName.name(), componentVendorName);
091                }
092            } else {
093                var entityInstance = entityInstanceControl.getEntityInstanceByEntityRef(entityRef);
094                
095                if(entityInstance != null) {
096                    entityType = entityInstance.getEntityType();
097                } else {
098                    addExecutionError(ExecutionErrors.UnknownEntityRef.name(), entityRef);
099                }
100            }
101            
102            if(!hasExecutionErrors()) {
103                var entityAttributeName = form.getEntityAttributeName();
104                var entityAttribute = coreControl.getEntityAttributeByName(entityType, entityAttributeName);
105                
106                if(entityAttribute != null) {
107                    var entityAttributeType = entityAttribute.getLastDetail().getEntityAttributeType();
108                    var entityAttributeTypeName = entityAttributeType.getEntityAttributeTypeName();
109                    
110                    if(entityAttributeTypeName.equals(EntityAttributeTypes.LONG.name())) {
111                        var defaultEntityLongRangeChoice = form.getDefaultEntityLongRangeChoice();
112                        var allowNullChoice = Boolean.valueOf(form.getAllowNullChoice());
113                        
114                        result.setEntityLongRangeChoices(coreControl.getEntityLongRangeChoices(defaultEntityLongRangeChoice,
115                                getPreferredLanguage(), allowNullChoice, entityAttribute));
116                    } else {
117                        addExecutionError(ExecutionErrors.InvalidEntityAttributeType.name());
118                    }
119                } else {
120                    addExecutionError(ExecutionErrors.UnknownEntityAttributeName.name(), entityAttributeName);
121                }
122            }
123        } else {
124            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
125        }
126        
127        return result;
128    }
129    
130}