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.GetChainActionSetDescriptionForm;
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 java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class GetChainActionSetDescriptionCommand
041        extends BaseSimpleCommand<GetChainActionSetDescriptionForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.ChainActionSet.name(), SecurityRoles.Description.name())
051                ))
052        ));
053        
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("ChainName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("ChainActionSetName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
060        );
061    }
062
063    @Inject
064    ChainControl chainControl;
065
066    @Inject
067    PartyControl partyControl;
068
069    
070    /** Creates a new instance of GetChainActionSetDescriptionCommand */
071    public GetChainActionSetDescriptionCommand() {
072        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
073    }
074    
075    @Override
076    protected BaseResult execute() {
077        var result = ChainResultFactory.getGetChainActionSetDescriptionResult();
078        var chainKindName = form.getChainKindName();
079        var chainKind = chainControl.getChainKindByName(chainKindName);
080
081        if(chainKind != null) {
082            var chainTypeName = form.getChainTypeName();
083            var chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
084
085            if(chainType != null) {
086                var chainName = form.getChainName();
087                var chain = chainControl.getChainByName(chainType, chainName);
088
089                if(chain != null) {
090                    var chainActionSetName = form.getChainActionSetName();
091                    var chainActionSet = chainControl.getChainActionSetByName(chain, chainActionSetName);
092
093                    if(chainActionSet != null) {
094                        var languageIsoName = form.getLanguageIsoName();
095                        var language = partyControl.getLanguageByIsoName(languageIsoName);
096
097                        if(language != null) {
098                            var chainActionSetDescription = chainControl.getChainActionSetDescription(chainActionSet, language);
099
100                            if(chainActionSetDescription != null) {
101                                result.setChainActionSetDescription(chainControl.getChainActionSetDescriptionTransfer(getUserVisit(), chainActionSetDescription));
102                            } else {
103                                addExecutionError(ExecutionErrors.UnknownChainActionSetDescription.name(), chainKindName, chainTypeName, chainName, chainActionSetName, languageIsoName);
104                            }
105                        } else {
106                            addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
107                        }
108                    } else {
109                        addExecutionError(ExecutionErrors.UnknownChainActionSetName.name(), chainKindName, chainTypeName, chainName, chainActionSetName);
110                    }
111                } else {
112                    addExecutionError(ExecutionErrors.UnknownChainName.name(), chainKindName, chainTypeName, chainName);
113                }
114            } else {
115                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainKindName, chainTypeName);
116            }
117        } else {
118            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
119        }
120        
121        return result;
122    }
123    
124}