001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.GetChainActionForm;
020import com.echothree.control.user.chain.common.result.ChainResultFactory;
021import com.echothree.model.control.chain.server.control.ChainControl;
022import com.echothree.model.control.core.common.EventTypes;
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.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039import javax.enterprise.context.RequestScoped;
040
041@RequestScoped
042public class GetChainActionCommand
043        extends BaseSimpleCommand<GetChainActionForm> {
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(Collections.unmodifiableList(Arrays.asList(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                    new SecurityRoleDefinition(SecurityRoleGroups.ChainAction.name(), SecurityRoles.Review.name())
053                    )))
054                )));
055
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
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                new FieldDefinition("ChainActionName", FieldType.ENTITY_NAME, true, null, null)
062                ));
063    }
064    
065    /** Creates a new instance of GetChainActionCommand */
066    public GetChainActionCommand() {
067        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
068    }
069    
070    @Override
071    protected BaseResult execute() {
072        var chainControl = Session.getModelController(ChainControl.class);
073        var result = ChainResultFactory.getGetChainActionResult();
074        var chainKindName = form.getChainKindName();
075        var chainKind = chainControl.getChainKindByName(chainKindName);
076        
077        if(chainKind != null) {
078            var chainTypeName = form.getChainTypeName();
079            var chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
080
081            if(chainType != null) {
082                var chainName = form.getChainName();
083                var chain = chainControl.getChainByName(chainType, chainName);
084
085                if(chain != null) {
086                    var chainActionSetName = form.getChainActionSetName();
087                    var chainActionSet = chainControl.getChainActionSetByName(chain, chainActionSetName);
088
089                    if(chainActionSet != null) {
090                        var chainActionName = form.getChainActionName();
091                        var chainAction = chainControl.getChainActionByName(chainActionSet, chainActionName);
092
093                        if(chainAction != null) {
094                            result.setChainAction(chainControl.getChainActionTransfer(getUserVisit(), chainAction));
095
096                            sendEvent(chainAction.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
097                        } else {
098                            addExecutionError(ExecutionErrors.UnknownChainActionName.name(), chainKindName, chainTypeName, chainName, chainActionSetName,
099                                    chainActionName);
100                        }
101                    } else {
102                        addExecutionError(ExecutionErrors.UnknownChainActionSetName.name(), chainKindName, chainTypeName, chainName, chainActionSetName);
103                    }
104                } else {
105                    addExecutionError(ExecutionErrors.UnknownChainName.name(), chainKindName, chainTypeName, chainName);
106                }
107            } else {
108                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainKindName, chainTypeName);
109            }
110        } else {
111            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
112        }
113        
114        return result;
115    }
116    
117}