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.chain.server.command;
018
019import com.echothree.control.user.chain.common.form.GetChainInstancesForm;
020import com.echothree.control.user.chain.common.result.ChainResultFactory;
021import com.echothree.model.control.chain.server.control.ChainControl;
022import com.echothree.model.control.chain.server.logic.ChainLogic;
023import com.echothree.model.data.chain.server.entity.Chain;
024import com.echothree.model.data.chain.server.entity.ChainInstance;
025import com.echothree.model.data.chain.server.factory.ChainInstanceFactory;
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 GetChainInstancesCommand
037        extends BasePaginatedMultipleEntitiesCommand<ChainInstance, GetChainInstancesForm> {
038    
039    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
040    
041    static {
042        FORM_FIELD_DEFINITIONS = List.of(
043                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
044                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
045                new FieldDefinition("ChainName", FieldType.ENTITY_NAME, true, null, null)
046        );
047    }
048    
049    @Inject
050    ChainControl chainControl;
051
052    @Inject
053    ChainLogic chainLogic;
054
055    /** Creates a new instance of GetChainInstancesCommand */
056    public GetChainInstancesCommand() {
057        super(null, FORM_FIELD_DEFINITIONS, true);
058    }
059
060    Chain chain;
061
062    @Override
063    protected void handleForm() {
064        chain = chainLogic.getChainByName(this, form.getChainKindName(), form.getChainTypeName(), form.getChainName());
065    }
066
067    @Override
068    protected Long getTotalEntities() {
069        return hasExecutionErrors() ? null : chainControl.countChainInstancesByChain(chain);
070    }
071
072    @Override
073    protected Collection<ChainInstance> getEntities() {
074        return hasExecutionErrors() ? null : chainControl.getChainInstancesByChain(chain);
075    }
076
077    @Override
078    protected BaseResult getResult(Collection<ChainInstance> entities) {
079        var result = ChainResultFactory.getGetChainInstancesResult();
080
081        if(entities != null) {
082            result.setChain(chainControl.getChainTransfer(getUserVisit(), chain));
083
084            if(session.hasLimit(ChainInstanceFactory.class)) {
085                result.setChainInstanceCount(getTotalEntities());
086            }
087
088            result.setChainInstances(chainControl.getChainInstanceTransfers(getUserVisit(), entities));
089        }
090
091        return result;
092    }
093    
094}