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.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;
034
035public class GetEntityAttributeGroupsCommand
036        extends BasePaginatedMultipleEntitiesCommand<EntityAttributeGroup, GetEntityAttributeGroupsForm> {
037    
038    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
039    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
040    
041    static {
042        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
043                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
044                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
045                        new SecurityRoleDefinition(SecurityRoleGroups.EntityAttributeGroup.name(), SecurityRoles.List.name())
046                ))
047        ));
048        
049        FORM_FIELD_DEFINITIONS = List.of(
050        );
051    }
052
053    /** Creates a new instance of GetEntityAttributeGroupsCommand */
054    public GetEntityAttributeGroupsCommand(UserVisitPK userVisitPK, GetEntityAttributeGroupsForm form) {
055        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
056    }
057
058    @Override
059    protected void handleForm() {
060        // No form fields.
061    }
062
063    @Override
064    protected Long getTotalEntities() {
065        return getCoreControl().countEntityAttributeGroups();
066    }
067
068    @Override
069    protected Collection<EntityAttributeGroup> getEntities() {
070        return getCoreControl().getEntityAttributeGroups();
071    }
072
073    @Override
074    protected BaseResult getResult(Collection<EntityAttributeGroup> entities) {
075        var result = CoreResultFactory.getGetEntityAttributeGroupsResult();
076
077        if(entities != null) {
078            result.setEntityAttributeGroups(getCoreControl().getEntityAttributeGroupTransfers(getUserVisit(), entities, null));
079        }
080
081        return result;
082    }
083    
084}