001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.GetEntityAttributeGroupDescriptionForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.server.control.EntityAttributeGroupControl;
022import com.echothree.model.control.core.server.logic.EntityAttributeGroupLogic;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.party.server.control.PartyControl;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class GetEntityAttributeGroupDescriptionCommand
041        extends BaseSimpleCommand<GetEntityAttributeGroupDescriptionForm> {
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(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.EntityAttributeGroup.name(), SecurityRoles.Description.name())
051                ))
052        ));
053        
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, true, null, null),
057                new FieldDefinition("EntityAttributeGroupName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
059        );
060    }
061
062    @Inject
063    protected EntityAttributeGroupControl entityAttributeGroupControl;
064
065    @Inject
066    protected EntityAttributeGroupLogic entityAttributeGroupLogic;
067
068    @Inject
069    PartyControl partyControl;
070
071    /** Creates a new instance of GetEntityAttributeGroupDescriptionCommand */
072    public GetEntityAttributeGroupDescriptionCommand() {
073        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
074    }
075    
076    @Override
077    protected BaseResult execute() {
078        var result = CoreResultFactory.getGetEntityAttributeGroupDescriptionResult();
079        var entityAttributeGroupName = form.getEntityAttributeGroupName();
080        var entityAttributeGroup = entityAttributeGroupLogic.getEntityAttributeGroupByName(this, form.getComponentVendorName(), form.getEntityTypeName(), entityAttributeGroupName);
081        
082        if(entityAttributeGroup != null) {
083            var languageIsoName = form.getLanguageIsoName();
084            var language = partyControl.getLanguageByIsoName(languageIsoName);
085            
086            if(language != null) {
087                var entityAttributeGroupDescription = entityAttributeGroupControl.getEntityAttributeGroupDescription(entityAttributeGroup, language);
088                
089                if(entityAttributeGroupDescription != null) {
090                    result.setEntityAttributeGroupDescription(entityAttributeGroupControl.getEntityAttributeGroupDescriptionTransfer(getUserVisit(), entityAttributeGroupDescription, null));
091                } else {
092                    addExecutionError(ExecutionErrors.UnknownEntityAttributeGroupDescription.name(), form.getComponentVendorName(), form.getEntityTypeName(), entityAttributeGroupName, languageIsoName);
093                }
094            } else {
095                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
096            }
097        }
098        
099        return result;
100    }
101    
102}