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.GetEntityAttributeDescriptionForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.control.user.core.common.result.GetEntityAttributeDescriptionResult;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.party.server.control.PartyControl;
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.EntityAttributeDescription;
029import com.echothree.model.data.core.server.entity.EntityType;
030import com.echothree.model.data.party.server.entity.Language;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.common.command.BaseResult;
036import com.echothree.util.server.control.BaseSimpleCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import com.echothree.util.server.persistence.Session;
041import java.util.Arrays;
042import java.util.Collections;
043import java.util.List;
044
045public class GetEntityAttributeDescriptionCommand
046        extends BaseSimpleCommand<GetEntityAttributeDescriptionForm> {
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.EntityAttribute.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                ));
064    }
065    
066    /** Creates a new instance of GetEntityAttributeDescriptionCommand */
067    public GetEntityAttributeDescriptionCommand(UserVisitPK userVisitPK, GetEntityAttributeDescriptionForm form) {
068        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
069    }
070    
071    @Override
072    protected BaseResult execute() {
073        var coreControl = getCoreControl();
074        GetEntityAttributeDescriptionResult result = CoreResultFactory.getGetEntityAttributeDescriptionResult();
075        String componentVendorName = form.getComponentVendorName();
076        ComponentVendor componentVendor = coreControl.getComponentVendorByName(componentVendorName);
077
078        if(componentVendor != null) {
079            String entityTypeName = form.getEntityTypeName();
080            EntityType entityType = coreControl.getEntityTypeByName(componentVendor, entityTypeName);
081
082            if(entityType != null) {
083                String entityAttributeName = form.getEntityAttributeName();
084                EntityAttribute entityAttribute = coreControl.getEntityAttributeByName(entityType, entityAttributeName);
085
086                if(entityAttribute != null) {
087                    var partyControl = Session.getModelController(PartyControl.class);
088                    String languageIsoName = form.getLanguageIsoName();
089                    Language language = partyControl.getLanguageByIsoName(languageIsoName);
090
091                    if(language != null) {
092                        EntityAttributeDescription entityAttributeDescription = coreControl.getEntityAttributeDescription(entityAttribute, language);
093
094                        if(entityAttributeDescription != null) {
095                            result.setEntityAttributeDescription(coreControl.getEntityAttributeDescriptionTransfer(getUserVisit(), entityAttributeDescription, null));
096                        } else {
097                            addExecutionError(ExecutionErrors.UnknownEntityAttributeDescription.name(), componentVendorName, entityTypeName, entityAttributeName,
098                                    languageIsoName);
099                        }
100                    } else {
101                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
102                    }
103                } else {
104                    addExecutionError(ExecutionErrors.UnknownEntityAttributeName.name(), entityAttributeName);
105                }
106            } else {
107                addExecutionError(ExecutionErrors.UnknownEntityTypeName.name(), entityTypeName);
108            }
109        } else {
110            addExecutionError(ExecutionErrors.UnknownComponentVendorName.name(), componentVendorName);
111        }
112
113        return result;
114    }
115    
116}