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.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.data.core.server.entity.EntityAttributeGroup;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
029import com.echothree.util.server.control.CommandSecurityDefinition;
030import com.echothree.util.server.control.PartyTypeDefinition;
031import com.echothree.util.server.control.SecurityRoleDefinition;
032import java.util.Collection;
033import java.util.List;
034import javax.enterprise.context.Dependent;
035
036@Dependent
037public class GetEntityAttributeGroupsCommand
038        extends BasePaginatedMultipleEntitiesCommand<EntityAttributeGroup, GetEntityAttributeGroupsForm> {
039    
040    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
041    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
042    
043    static {
044        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
045                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
046                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
047                        new SecurityRoleDefinition(SecurityRoleGroups.EntityAttributeGroup.name(), SecurityRoles.List.name())
048                ))
049        ));
050        
051        FORM_FIELD_DEFINITIONS = List.of();
052    }
053
054    /** Creates a new instance of GetEntityAttributeGroupsCommand */
055    public GetEntityAttributeGroupsCommand() {
056        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
057    }
058
059    @Override
060    protected void handleForm() {
061        // No form fields.
062    }
063
064    @Override
065    protected Long getTotalEntities() {
066        return coreControl.countEntityAttributeGroups();
067    }
068
069    @Override
070    protected Collection<EntityAttributeGroup> getEntities() {
071        return coreControl.getEntityAttributeGroups();
072    }
073
074    @Override
075    protected BaseResult getResult(Collection<EntityAttributeGroup> entities) {
076        var result = CoreResultFactory.getGetEntityAttributeGroupsResult();
077
078        if(entities != null) {
079            result.setEntityAttributeGroups(coreControl.getEntityAttributeGroupTransfers(getUserVisit(), entities, null));
080        }
081
082        return result;
083    }
084    
085}