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