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