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.GetChainActionDescriptionsForm;
020import com.echothree.control.user.chain.common.result.ChainResultFactory;
021import com.echothree.model.control.chain.server.control.ChainControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037
038@Dependent
039public class GetChainActionDescriptionsCommand
040        extends BaseSimpleCommand<GetChainActionDescriptionsForm> {
041    
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.ChainAction.name(), SecurityRoles.Description.name())
050                        ))
051                ));
052
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("ChainName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("ChainActionSetName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("ChainActionName", FieldType.ENTITY_NAME, true, null, null)
059                );
060    }
061    
062    /** Creates a new instance of GetChainActionDescriptionsCommand */
063    public GetChainActionDescriptionsCommand() {
064        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var chainControl = Session.getModelController(ChainControl.class);
070        var result = ChainResultFactory.getGetChainActionDescriptionsResult();
071        var chainKindName = form.getChainKindName();
072        var chainKind = chainControl.getChainKindByName(chainKindName);
073        
074        if(chainKind != null) {
075            var chainTypeName = form.getChainTypeName();
076            var chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
077
078            if(chainType != null) {
079                var chainName = form.getChainName();
080                var chain = chainControl.getChainByName(chainType, chainName);
081
082                if(chain != null) {
083                    var chainActionSetName = form.getChainActionSetName();
084                    var chainActionSet = chainControl.getChainActionSetByName(chain, chainActionSetName);
085
086                    if(chainActionSet != null) {
087                        var chainActionName = form.getChainActionName();
088                        var chainAction = chainControl.getChainActionByName(chainActionSet, chainActionName);
089
090                        if(chainAction != null) {
091                            result.setChainAction(chainControl.getChainActionTransfer(getUserVisit(), chainAction));
092                            result.setChainActionDescriptions(chainControl.getChainActionDescriptionTransfersByChainAction(getUserVisit(), chainAction));
093                        } else {
094                            addExecutionError(ExecutionErrors.UnknownChainActionName.name(), chainKindName, chainTypeName, chainName, chainActionSetName,
095                                    chainActionName);
096                        }
097                    } else {
098                        addExecutionError(ExecutionErrors.UnknownChainActionSetName.name(), chainKindName, chainTypeName, chainName, chainActionSetName);
099                    }
100                } else {
101                    addExecutionError(ExecutionErrors.UnknownChainName.name(), chainKindName, chainTypeName, chainName);
102                }
103            } else {
104                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainKindName, chainTypeName);
105            }
106        } else {
107            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
108        }
109        
110        return result;
111    }
112    
113}