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.GetEntityAttributeDescriptionsForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.control.user.core.common.result.GetEntityAttributeDescriptionsResult;
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.core.server.entity.ComponentVendor;
026import com.echothree.model.data.core.server.entity.EntityAttribute;
027import com.echothree.model.data.core.server.entity.EntityType;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.model.data.user.server.entity.UserVisit;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.common.command.BaseResult;
034import com.echothree.util.server.control.BaseSimpleCommand;
035import com.echothree.util.server.control.CommandSecurityDefinition;
036import com.echothree.util.server.control.PartyTypeDefinition;
037import com.echothree.util.server.control.SecurityRoleDefinition;
038import java.util.Arrays;
039import java.util.Collections;
040import java.util.List;
041
042public class GetEntityAttributeDescriptionsCommand
043        extends BaseSimpleCommand<GetEntityAttributeDescriptionsForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                        new SecurityRoleDefinition(SecurityRoleGroups.EntityAttribute.name(), SecurityRoles.Description.name())
053                        )))
054                )));
055        
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, true, null, null),
059                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, true, null, null)
060                ));
061    }
062    
063    /** Creates a new instance of GetEntityAttributeDescriptionsCommand */
064    public GetEntityAttributeDescriptionsCommand(UserVisitPK userVisitPK, GetEntityAttributeDescriptionsForm form) {
065        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        var coreControl = getCoreControl();
071        GetEntityAttributeDescriptionsResult result = CoreResultFactory.getGetEntityAttributeDescriptionsResult();
072        String componentVendorName = form.getComponentVendorName();
073        ComponentVendor componentVendor = coreControl.getComponentVendorByName(componentVendorName);
074        
075        if(componentVendor != null) {
076            String entityTypeName = form.getEntityTypeName();
077            EntityType entityType = coreControl.getEntityTypeByName(componentVendor, entityTypeName);
078            
079            if(entityType != null) {
080                String entityAttributeName = form.getEntityAttributeName();
081                EntityAttribute entityAttribute = coreControl.getEntityAttributeByName(entityType, entityAttributeName);
082                
083                if(entityAttribute != null) {
084                    UserVisit userVisit = getUserVisit();
085                    
086                    result.setEntityAttribute(coreControl.getEntityAttributeTransfer(userVisit, entityAttribute, null));
087                    result.setEntityAttributeDescriptions(coreControl.getEntityAttributeDescriptionTransfersByEntityAttribute(userVisit, entityAttribute, null));
088                } else {
089                    addExecutionError(ExecutionErrors.UnknownEntityAttributeName.name(), entityAttributeName);
090                }
091            } else {
092                addExecutionError(ExecutionErrors.UnknownEntityTypeName.name(), entityTypeName);
093            }
094        } else {
095            addExecutionError(ExecutionErrors.UnknownComponentVendorName.name(), componentVendorName);
096        }
097        
098        return result;
099    }
100    
101}