001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.CreateEntityAttributeDescriptionForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.party.server.control.PartyControl;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.util.common.message.ExecutionErrors;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import com.echothree.util.server.persistence.Session;
034import java.util.Arrays;
035import java.util.Collections;
036import java.util.List;
037import javax.enterprise.context.RequestScoped;
038
039@RequestScoped
040public class CreateEntityAttributeDescriptionCommand
041        extends BaseSimpleCommand<CreateEntityAttributeDescriptionForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
050                        new SecurityRoleDefinition(SecurityRoleGroups.EntityAttribute.name(), SecurityRoles.Description.name())
051                        )))
052                )));
053        
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, true, null, null),
057                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
060                ));
061    }
062    
063    /** Creates a new instance of CreateEntityAttributeDescriptionCommand */
064    public CreateEntityAttributeDescriptionCommand() {
065        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        var componentVendorName = form.getComponentVendorName();
071        var componentVendor = componentControl.getComponentVendorByName(componentVendorName);
072        
073        if(componentVendor != null) {
074            var entityTypeName = form.getEntityTypeName();
075            var entityType = entityTypeControl.getEntityTypeByName(componentVendor, entityTypeName);
076            
077            if(entityType != null) {
078                var entityAttributeName = form.getEntityAttributeName();
079                var entityAttribute = coreControl.getEntityAttributeByName(entityType, entityAttributeName);
080                
081                if(entityAttribute != null) {
082                    var partyControl = Session.getModelController(PartyControl.class);
083                    var languageIsoName = form.getLanguageIsoName();
084                    var language = partyControl.getLanguageByIsoName(languageIsoName);
085                    
086                    if(language != null) {
087                        var entityAttributeDescription = coreControl.getEntityAttributeDescription(entityAttribute, language);
088                        
089                        if(entityAttributeDescription == null) {
090                            var description = form.getDescription();
091                            
092                            coreControl.createEntityAttributeDescription(entityAttribute, language, description, getPartyPK());
093                        } else {
094                            addExecutionError(ExecutionErrors.DuplicateEntityAttributeDescription.name(), componentVendorName, entityTypeName, entityAttributeName, languageIsoName);
095                        }
096                    } else {
097                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
098                    }
099                } else {
100                    addExecutionError(ExecutionErrors.UnknownEntityAttributeName.name(), componentVendorName, entityTypeName, entityAttributeName);
101                }
102            } else {
103                addExecutionError(ExecutionErrors.UnknownEntityTypeName.name(), componentVendorName, entityTypeName);
104            }
105        } else {
106            addExecutionError(ExecutionErrors.UnknownComponentVendorName.name(), componentVendorName);
107        }
108        
109        return null;
110    }
111    
112}