001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.util.server.control;
018
019import com.echothree.model.data.user.common.pk.UserVisitPK;
020import com.echothree.util.common.command.BaseResult;
021import com.echothree.util.common.command.SecurityResult;
022import com.echothree.util.common.form.BaseForm;
023import com.echothree.util.common.validation.FieldDefinition;
024import com.echothree.util.server.persistence.BaseEntity;
025import java.util.Collection;
026import java.util.List;
027
028public abstract class BaseMultipleEntitiesCommand<BE extends BaseEntity, F extends BaseForm>
029        extends BaseSimpleCommand<F>
030        implements GraphQlSecurityCommand<F> {
031    
032    protected BaseMultipleEntitiesCommand(CommandSecurityDefinition commandSecurityDefinition,
033            List<FieldDefinition> formFieldDefinitions, boolean allowLimits) {
034        super(commandSecurityDefinition, formFieldDefinitions, allowLimits);
035    }
036    
037    protected abstract Collection<BE> getEntities();
038    protected abstract BaseResult getResult(Collection<BE> entities);
039
040    public Collection<BE> getEntitiesForGraphQl(UserVisitPK userVisitPK, F form) {
041        Collection<BE> entities = null;
042
043        if(canQueryByGraphQl(userVisitPK, form)) {
044            entities = getEntities();
045        }
046        
047        return entities;
048    }
049
050    @Override
051    public SecurityResult security(UserVisitPK userVisitPK, F form) {
052        this.form = form;
053        setUserVisitPK(userVisitPK);
054
055        return super.security();
056    }
057
058    @Override
059    protected BaseResult execute() {
060        var entities = getEntities();
061        
062        return getResult(entities);
063    }
064    
065}