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.GetEntityLongRangeDescriptionsForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.control.user.core.common.result.GetEntityLongRangeDescriptionsResult;
022import com.echothree.model.control.core.common.EntityAttributeTypes;
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.ComponentVendor;
027import com.echothree.model.data.core.server.entity.EntityAttribute;
028import com.echothree.model.data.core.server.entity.EntityAttributeType;
029import com.echothree.model.data.core.server.entity.EntityLongRange;
030import com.echothree.model.data.core.server.entity.EntityType;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
032import com.echothree.model.data.user.server.entity.UserVisit;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.validation.FieldDefinition;
035import com.echothree.util.common.validation.FieldType;
036import com.echothree.util.common.command.BaseResult;
037import com.echothree.util.server.control.BaseSimpleCommand;
038import com.echothree.util.server.control.CommandSecurityDefinition;
039import com.echothree.util.server.control.PartyTypeDefinition;
040import com.echothree.util.server.control.SecurityRoleDefinition;
041import java.util.Arrays;
042import java.util.Collections;
043import java.util.List;
044
045public class GetEntityLongRangeDescriptionsCommand
046        extends BaseSimpleCommand<GetEntityLongRangeDescriptionsForm> {
047    
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
055                        new SecurityRoleDefinition(SecurityRoleGroups.EntityLongRange.name(), SecurityRoles.Description.name())
056                        )))
057                )));
058        
059        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
060                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, true, null, null),
062                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("EntityLongRangeName", FieldType.ENTITY_NAME, true, null, null)
064                ));
065    }
066    
067    /** Creates a new instance of GetEntityLongRangeDescriptionsCommand */
068    public GetEntityLongRangeDescriptionsCommand(UserVisitPK userVisitPK, GetEntityLongRangeDescriptionsForm form) {
069        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
070    }
071    
072    @Override
073    protected BaseResult execute() {
074        var coreControl = getCoreControl();
075        GetEntityLongRangeDescriptionsResult result = CoreResultFactory.getGetEntityLongRangeDescriptionsResult();
076        String componentVendorName = form.getComponentVendorName();
077        ComponentVendor componentVendor = coreControl.getComponentVendorByName(componentVendorName);
078        
079        if(componentVendor != null) {
080            String entityTypeName = form.getEntityTypeName();
081            EntityType entityType = coreControl.getEntityTypeByName(componentVendor, entityTypeName);
082            
083            if(entityType != null) {
084                String entityAttributeName = form.getEntityAttributeName();
085                EntityAttribute entityAttribute = coreControl.getEntityAttributeByName(entityType, entityAttributeName);
086                
087                if(entityAttribute != null) {
088                    EntityAttributeType entityAttributeType = entityAttribute.getLastDetail().getEntityAttributeType();
089                    String entityAttributeTypeName = entityAttributeType.getEntityAttributeTypeName();
090                    
091                    if(entityAttributeTypeName.equals(EntityAttributeTypes.LONG.name())) {
092                        String entityLongRangeName = form.getEntityLongRangeName();
093                        EntityLongRange entityLongRange = coreControl.getEntityLongRangeByName(entityAttribute, entityLongRangeName);
094                        
095                        if(entityLongRange != null) {
096                            UserVisit userVisit = getUserVisit();
097                            
098                            result.setEntityLongRange(coreControl.getEntityLongRangeTransfer(userVisit, entityLongRange, null));
099                            result.setEntityLongRangeDescriptions(coreControl.getEntityLongRangeDescriptionTransfersByEntityLongRange(userVisit, entityLongRange, null));
100                        } else {
101                            addExecutionError(ExecutionErrors.UnknownEntityLongRangeName.name(), componentVendorName, entityTypeName, entityAttributeName, entityLongRangeName);
102                        }
103                    } else {
104                        addExecutionError(ExecutionErrors.InvalidEntityAttributeType.name(), componentVendorName, entityTypeName, entityAttributeName, entityAttributeTypeName);
105                    }
106                } else {
107                    addExecutionError(ExecutionErrors.UnknownEntityAttributeName.name(), componentVendorName, entityTypeName, entityAttributeName);
108                }
109            } else {
110                addExecutionError(ExecutionErrors.UnknownEntityTypeName.name(), componentVendorName, entityTypeName);
111            }
112        } else {
113            addExecutionError(ExecutionErrors.UnknownComponentVendorName.name(), componentVendorName);
114        }
115        
116        return result;
117    }
118    
119}