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.GetEntityAttributeEntityAttributeGroupForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.server.logic.EntityAttributeLogic;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.core.server.entity.EntityAttributeEntityAttributeGroup;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
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.BaseSingleEntityCommand;
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;
037
038@Dependent
039public class GetEntityAttributeEntityAttributeGroupCommand
040        extends BaseSingleEntityCommand<EntityAttributeEntityAttributeGroup, GetEntityAttributeEntityAttributeGroupForm> {
041
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.EntityAttribute.name(), SecurityRoles.EntityAttributeEntityAttributeGroup.name())
050                        ))
051                ));
052        
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, true, null, null),
056                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("EntityAttributeGroupName", FieldType.ENTITY_NAME, true, null, null)
058                );
059    }
060    
061    /** Creates a new instance of GetEntityAttributeEntityAttributeGroupCommand */
062    public GetEntityAttributeEntityAttributeGroupCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
064    }
065
066    @Override
067    protected EntityAttributeEntityAttributeGroup getEntity() {
068        var entityAttribute = EntityAttributeLogic.getInstance().getEntityAttributeByName(this, form.getComponentVendorName(), form.getEntityTypeName(), form.getEntityAttributeName());
069        EntityAttributeEntityAttributeGroup result = null;
070
071        if(!hasExecutionErrors()) {
072            var entityAttributeGroup = EntityAttributeLogic.getInstance().getEntityAttributeGroupByName(this, form.getEntityAttributeGroupName());
073
074            if(!hasExecutionErrors()) {
075
076                result = coreControl.getEntityAttributeEntityAttributeGroup(entityAttribute, entityAttributeGroup);
077
078                if(result == null) {
079                    var entityAttributeDetail = entityAttribute.getLastDetail();
080                    var entityTypeDetail = entityAttributeDetail.getEntityType().getLastDetail();
081
082                    addExecutionError(ExecutionErrors.UnknownEntityAttributeEntityAttributeGroup.name(),
083                            entityTypeDetail.getComponentVendor().getLastDetail().getComponentVendorName(), entityTypeDetail.getEntityTypeName(),
084                            entityAttributeDetail.getEntityAttributeName(), entityAttributeGroup.getLastDetail().getEntityAttributeGroupName());
085                }
086            }
087        }
088
089        return result;
090    }
091
092    @Override
093    protected BaseResult getResult(EntityAttributeEntityAttributeGroup entity) {
094        var result = CoreResultFactory.getGetEntityAttributeEntityAttributeGroupResult();
095
096        if(entity != null) {
097
098            result.setEntityAttributeEntityAttributeGroup(coreControl.getEntityAttributeEntityAttributeGroupTransfer(getUserVisit(), entity, null));
099        }
100
101        return result;
102    }
103
104}