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.GetEntityAttributeGroupsForm;
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.EntityTypeLogic;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.core.server.entity.EntityAttributeGroup;
027import com.echothree.model.data.core.server.entity.EntityType;
028import com.echothree.model.data.core.server.factory.EntityAttributeGroupFactory;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.Collection;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
042public class GetEntityAttributeGroupsCommand
043        extends BasePaginatedMultipleEntitiesCommand<EntityAttributeGroup, GetEntityAttributeGroupsForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.EntityAttributeGroup.name(), SecurityRoles.List.name())
053                ))
054        ));
055        
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, true, null, null)
059        );
060    }
061
062    @Inject
063    protected EntityAttributeGroupControl entityAttributeGroupControl;
064
065    @Inject
066    protected EntityTypeLogic entityTypeLogic;
067
068    /** Creates a new instance of GetEntityAttributeGroupsCommand */
069    public GetEntityAttributeGroupsCommand() {
070        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
071    }
072
073    private EntityType entityType;
074
075    @Override
076    protected void handleForm() {
077        entityType = entityTypeLogic.getEntityTypeByName(this, form.getComponentVendorName(), form.getEntityTypeName());
078    }
079
080    @Override
081    protected Long getTotalEntities() {
082        return hasExecutionErrors() ? null : entityAttributeGroupControl.countEntityAttributeGroupsByEntityType(entityType);
083    }
084
085    @Override
086    protected Collection<EntityAttributeGroup> getEntities() {
087        return hasExecutionErrors() ? null : entityAttributeGroupControl.getEntityAttributeGroupsByEntityType(entityType);
088    }
089
090    @Override
091    protected BaseResult getResult(Collection<EntityAttributeGroup> entities) {
092        var result = CoreResultFactory.getGetEntityAttributeGroupsResult();
093
094        if(entities != null) {
095            var userVisit = getUserVisit();
096
097            result.setEntityType(entityTypeControl.getEntityTypeTransfer(userVisit, entityType));
098
099            if(session.hasLimit(EntityAttributeGroupFactory.class)) {
100                result.setEntityAttributeGroupCount(getTotalEntities());
101            }
102
103            result.setEntityAttributeGroups(entityAttributeGroupControl.getEntityAttributeGroupTransfers(userVisit, entities, null));
104        }
105
106        return result;
107    }
108    
109}