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.GetChainActionDescriptionForm;
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.party.server.control.PartyControl;
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 GetChainActionDescriptionCommand
043        extends BaseSimpleCommand<GetChainActionDescriptionForm> {
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.Description.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                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
063                ));
064    }
065    
066    /** Creates a new instance of GetChainActionDescriptionCommand */
067    public GetChainActionDescriptionCommand() {
068        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
069    }
070    
071    @Override
072    protected BaseResult execute() {
073        var chainControl = Session.getModelController(ChainControl.class);
074        var result = ChainResultFactory.getGetChainActionDescriptionResult();
075        var chainKindName = form.getChainKindName();
076        var chainKind = chainControl.getChainKindByName(chainKindName);
077
078        if(chainKind != null) {
079            var chainTypeName = form.getChainTypeName();
080            var chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
081
082            if(chainType != null) {
083                var chainName = form.getChainName();
084                var chain = chainControl.getChainByName(chainType, chainName);
085
086                if(chain != null) {
087                    var chainActionSetName = form.getChainActionSetName();
088                    var chainActionSet = chainControl.getChainActionSetByName(chain, chainActionSetName);
089
090                    if(chainActionSet != null) {
091                        var chainActionName = form.getChainActionName();
092                        var chainAction = chainControl.getChainActionByName(chainActionSet, chainActionName);
093
094                        if(chainAction != null) {
095                            var partyControl = Session.getModelController(PartyControl.class);
096                            var languageIsoName = form.getLanguageIsoName();
097                            var language = partyControl.getLanguageByIsoName(languageIsoName);
098
099                            if(language != null) {
100                                var chainActionDescription = chainControl.getChainActionDescription(chainAction, language);
101
102                                if(chainActionDescription != null) {
103                                    result.setChainActionDescription(chainControl.getChainActionDescriptionTransfer(getUserVisit(), chainActionDescription));
104                                } else {
105                                    addExecutionError(ExecutionErrors.UnknownChainActionDescription.name(), chainKindName, chainTypeName, chainName,
106                                            chainActionSetName, chainActionName, languageIsoName);
107                                }
108                            } else {
109                                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
110                            }
111                        } else {
112                            addExecutionError(ExecutionErrors.UnknownChainActionName.name(), chainKindName, chainTypeName, chainName, chainActionSetName, chainActionName);
113                        }
114                    } else {
115                        addExecutionError(ExecutionErrors.UnknownChainActionSetName.name(), chainKindName, chainTypeName, chainName, chainActionSetName);
116                    }
117                } else {
118                    addExecutionError(ExecutionErrors.UnknownChainName.name(), chainKindName, chainTypeName, chainName);
119                }
120            } else {
121                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainKindName, chainTypeName);
122            }
123        } else {
124            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
125        }
126        
127        return result;
128    }
129    
130}