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.batch.server.command;
018
019import com.echothree.control.user.batch.common.form.GetBatchAliasesForm;
020import com.echothree.control.user.batch.common.result.BatchResultFactory;
021import com.echothree.model.control.batch.server.control.BatchControl;
022import com.echothree.model.control.batch.server.logic.BatchLogic;
023import com.echothree.model.data.batch.server.entity.Batch;
024import com.echothree.model.data.batch.server.entity.BatchAlias;
025import com.echothree.model.data.batch.server.factory.BatchAliasFactory;
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 GetBatchAliasesCommand
037        extends BasePaginatedMultipleEntitiesCommand<BatchAlias, GetBatchAliasesForm> {
038
039    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
040
041    static {
042        FORM_FIELD_DEFINITIONS = List.of(
043                new FieldDefinition("BatchTypeName", FieldType.ENTITY_NAME, true, null, null),
044                new FieldDefinition("BatchName", FieldType.ENTITY_NAME, true, null, null)
045        );
046    }
047
048    @Inject
049    BatchControl batchControl;
050
051    @Inject
052    BatchLogic batchLogic;
053
054    /** Creates a new instance of GetBatchAliasesCommand */
055    public GetBatchAliasesCommand() {
056        super(null, FORM_FIELD_DEFINITIONS, false);
057    }
058
059    private Batch batch;
060
061    @Override
062    protected void handleForm() {
063        batch = batchLogic.getBatchByName(this, form.getBatchTypeName(), form.getBatchName());
064    }
065
066    @Override
067    protected Long getTotalEntities() {
068        return hasExecutionErrors() ? null : batchControl.countBatchAliasesByBatch(batch);
069    }
070
071    @Override
072    protected Collection<BatchAlias> getEntities() {
073        return hasExecutionErrors() ? null : batchControl.getBatchAliasesByBatch(batch);
074    }
075
076    @Override
077    protected BaseResult getResult(Collection<BatchAlias> entities) {
078        var result = BatchResultFactory.getGetBatchAliasesResult();
079
080        if(entities != null) {
081            var userVisit = getUserVisit();
082
083            result.setBatch(batchControl.getBatchTransfer(userVisit, batch));
084
085            if(session.hasLimit(BatchAliasFactory.class)) {
086                result.setBatchAliasCount(getTotalEntities());
087            }
088
089            result.setBatchAliases(batchControl.getBatchAliasTransfersByBatch(userVisit, batch));
090        }
091
092        return result;
093    }
094
095}