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.GetChainActionSetsForm;
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.control.party.common.PartyTypes;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.chain.server.entity.Chain;
027import com.echothree.model.data.chain.server.entity.ChainActionSet;
028import com.echothree.model.data.chain.server.factory.ChainActionSetFactory;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.Collection;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
042public class GetChainActionSetsCommand
043        extends BasePaginatedMultipleEntitiesCommand<ChainActionSet, GetChainActionSetsForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.ChainActionSet.name(), SecurityRoles.List.name())
053                ))
054        ));
055
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("ChainName", FieldType.ENTITY_NAME, true, null, null)
060        );
061    }
062
063    @Inject
064    ChainControl chainControl;
065
066    @Inject
067    ChainLogic chainLogic;
068
069    
070    /** Creates a new instance of GetChainActionSetsCommand */
071    public GetChainActionSetsCommand() {
072        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
073    }
074
075    private Chain chain;
076
077    @Override
078    protected void handleForm() {
079        chain = chainLogic.getChainByName(this, form.getChainKindName(), form.getChainTypeName(), form.getChainName());
080    }
081
082    @Override
083    protected Long getTotalEntities() {
084        return hasExecutionErrors() ? null : chainControl.countChainActionSetsByChain(chain);
085    }
086
087    @Override
088    protected Collection<ChainActionSet> getEntities() {
089        return hasExecutionErrors() ? null : chainControl.getChainActionSetsByChain(chain);
090    }
091
092    @Override
093    protected BaseResult getResult(Collection<ChainActionSet> entities) {
094        var result = ChainResultFactory.getGetChainActionSetsResult();
095
096        if(entities != null) {
097            result.setChain(chainControl.getChainTransfer(getUserVisit(), chain));
098
099            if(session.hasLimit(ChainActionSetFactory.class)) {
100                result.setChainActionSetCount(getTotalEntities());
101            }
102
103            result.setChainActionSets(chainControl.getChainActionSetTransfersByChain(getUserVisit(), chain));
104        }
105
106        return result;
107    }
108    
109}