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.CreateEntityLongRangeDescriptionForm;
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.EntityLongRange;
027import com.echothree.model.data.core.server.entity.EntityLongRangeDescription;
028import com.echothree.model.data.core.server.entity.EntityType;
029import com.echothree.model.data.party.server.entity.Language;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.BaseResult;
035import com.echothree.util.server.control.BaseSimpleCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.Arrays;
041import java.util.Collections;
042import java.util.List;
043
044public class CreateEntityLongRangeDescriptionCommand
045        extends BaseSimpleCommand<CreateEntityLongRangeDescriptionForm> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
049    
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
054                        new SecurityRoleDefinition(SecurityRoleGroups.EntityLongRange.name(), SecurityRoles.Description.name())
055                        )))
056                )));
057        
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, true, null, null),
061                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("EntityLongRangeName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
065                ));
066    }
067    
068    /** Creates a new instance of CreateEntityLongRangeDescriptionCommand */
069    public CreateEntityLongRangeDescriptionCommand(UserVisitPK userVisitPK, CreateEntityLongRangeDescriptionForm form) {
070        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
071    }
072    
073    @Override
074    protected BaseResult execute() {
075        var coreControl = getCoreControl();
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                    String entityLongRangeName = form.getEntityLongRangeName();
089                    EntityLongRange entityLongRange = coreControl.getEntityLongRangeByName(entityAttribute, entityLongRangeName);
090                    
091                    if(entityLongRange != null) {
092                        var partyControl = Session.getModelController(PartyControl.class);
093                        String languageIsoName = form.getLanguageIsoName();
094                        Language language = partyControl.getLanguageByIsoName(languageIsoName);
095                        
096                        if(language != null) {
097                            EntityLongRangeDescription entityLongRangeDescription = coreControl.getEntityLongRangeDescription(entityLongRange, language);
098                            
099                            if(entityLongRangeDescription == null) {
100                                var description = form.getDescription();
101                                
102                                coreControl.createEntityLongRangeDescription(entityLongRange, language, description, getPartyPK());
103                            } else {
104                                addExecutionError(ExecutionErrors.DuplicateEntityLongRangeDescription.name(), componentVendorName, entityTypeName,
105                                        entityAttributeName, entityLongRangeName, languageIsoName);
106                            }
107                        } else {
108                            addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
109                        }
110                    } else {
111                        addExecutionError(ExecutionErrors.UnknownEntityLongRangeName.name(), componentVendorName, entityTypeName, entityAttributeName, entityLongRangeName);
112                    }
113                } else {
114                    addExecutionError(ExecutionErrors.UnknownEntityAttributeName.name(), componentVendorName, entityTypeName, entityAttributeName);
115                }
116            } else {
117                addExecutionError(ExecutionErrors.UnknownEntityTypeName.name(), componentVendorName, entityTypeName);
118            }
119        } else {
120            addExecutionError(ExecutionErrors.UnknownComponentVendorName.name(), componentVendorName);
121        }
122        
123        return null;
124    }
125    
126}