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.associate.server.command;
018
019import com.echothree.control.user.associate.common.form.GetAssociatesForm;
020import com.echothree.control.user.associate.common.result.AssociateResultFactory;
021import com.echothree.model.control.associate.server.control.AssociateControl;
022import com.echothree.model.control.associate.server.logic.AssociateProgramLogic;
023import com.echothree.model.data.associate.server.entity.Associate;
024import com.echothree.model.data.associate.server.entity.AssociateProgram;
025import com.echothree.model.data.associate.server.factory.AssociateFactory;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
030import java.util.Collection;
031import java.util.List;
032import javax.enterprise.context.Dependent;
033import javax.inject.Inject;
034
035@Dependent
036public class GetAssociatesCommand
037        extends BasePaginatedMultipleEntitiesCommand<Associate, GetAssociatesForm> {
038    
039    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
040    
041    static {
042        FORM_FIELD_DEFINITIONS = List.of(
043                new FieldDefinition("AssociateProgramName", FieldType.ENTITY_NAME, true, null, null)
044        );
045    }
046
047    @Inject
048    AssociateControl associateControl;
049
050    @Inject
051    AssociateProgramLogic associateProgramLogic;
052    
053    /** Creates a new instance of GetAssociatesCommand */
054    public GetAssociatesCommand() {
055        super(null, FORM_FIELD_DEFINITIONS, true);
056    }
057    
058    AssociateProgram associateProgram;
059
060    @Override
061    protected void handleForm() {
062        associateProgram = associateProgramLogic.getAssociateProgramByName(this, form.getAssociateProgramName());
063    }
064
065    @Override
066    protected Long getTotalEntities() {
067        return hasExecutionErrors() ? null : associateControl.countAssociatesByAssociateProgram(associateProgram);
068    }
069
070    @Override
071    protected Collection<Associate> getEntities() {
072        return hasExecutionErrors() ? null : associateControl.getAssociates(associateProgram);
073    }
074
075    @Override
076    protected BaseResult getResult(final Collection<Associate> entities) {
077        var result = AssociateResultFactory.getGetAssociatesResult();
078
079        if(entities != null) {
080            var userVisit = getUserVisit();
081
082            result.setAssociateProgram(associateControl.getAssociateProgramTransfer(userVisit, associateProgram));
083
084            if(session.hasLimit(AssociateFactory.class)) {
085                result.setAssociateCount(getTotalEntities());
086            }
087
088            result.setAssociates(associateControl.getAssociateTransfers(entities, userVisit));
089        }
090
091        return result;
092    }
093    
094}