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.GetChainActionsForm;
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.ChainActionSetLogic;
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.ChainAction;
027import com.echothree.model.data.chain.server.entity.ChainActionSet;
028import com.echothree.model.data.chain.server.factory.ChainActionFactory;
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 GetChainActionsCommand
043        extends BasePaginatedMultipleEntitiesCommand<ChainAction, GetChainActionsForm> {
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.ChainAction.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                new FieldDefinition("ChainActionSetName", FieldType.ENTITY_NAME, true, null, null)
061        );
062    }
063
064    @Inject
065    ChainControl chainControl;
066
067    @Inject
068    ChainActionSetLogic chainActionSetLogic;
069
070    
071    /** Creates a new instance of GetChainActionsCommand */
072    public GetChainActionsCommand() {
073        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
074    }
075
076    ChainActionSet chainActionSet;
077
078    @Override
079    protected void handleForm() {
080        chainActionSet = chainActionSetLogic.getChainActionSetByName(this, form.getChainKindName(), form.getChainTypeName(),
081                form.getChainName(), form.getChainActionSetName());
082    }
083
084    @Override
085    protected Long getTotalEntities() {
086        return hasExecutionErrors() ? null : chainControl.countChainActionsByChainActionSet(chainActionSet);
087    }
088
089    @Override
090    protected Collection<ChainAction> getEntities() {
091        return hasExecutionErrors() ? null : chainControl.getChainActionsByChainActionSet(chainActionSet);
092    }
093
094    @Override
095    protected BaseResult getResult(Collection<ChainAction> entities) {
096        var result = ChainResultFactory.getGetChainActionsResult();
097
098        if(entities != null) {
099            result.setChainActionSet(chainControl.getChainActionSetTransfer(getUserVisit(), chainActionSet));
100
101            if(session.hasLimit(ChainActionFactory.class)) {
102                result.setChainActionCount(getTotalEntities());
103            }
104
105            result.setChainActions(chainControl.getChainActionTransfersByChainActionSet(getUserVisit(), chainActionSet));
106        }
107
108        return result;
109    }
110    
111}