001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.control.user.chain.common.result.GetChainActionDescriptionResult;
022import com.echothree.model.control.chain.server.control.ChainControl;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.party.server.control.PartyControl;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.chain.server.entity.Chain;
028import com.echothree.model.data.chain.server.entity.ChainAction;
029import com.echothree.model.data.chain.server.entity.ChainActionDescription;
030import com.echothree.model.data.chain.server.entity.ChainActionSet;
031import com.echothree.model.data.chain.server.entity.ChainKind;
032import com.echothree.model.data.chain.server.entity.ChainType;
033import com.echothree.model.data.party.server.entity.Language;
034import com.echothree.model.data.user.common.pk.UserVisitPK;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.validation.FieldDefinition;
037import com.echothree.util.common.validation.FieldType;
038import com.echothree.util.common.command.BaseResult;
039import com.echothree.util.server.control.BaseSimpleCommand;
040import com.echothree.util.server.control.CommandSecurityDefinition;
041import com.echothree.util.server.control.PartyTypeDefinition;
042import com.echothree.util.server.control.SecurityRoleDefinition;
043import com.echothree.util.server.persistence.Session;
044import java.util.Arrays;
045import java.util.Collections;
046import java.util.List;
047
048public class GetChainActionDescriptionCommand
049        extends BaseSimpleCommand<GetChainActionDescriptionForm> {
050    
051    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
052    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
053    
054    static {
055        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
056                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
057                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
058                        new SecurityRoleDefinition(SecurityRoleGroups.ChainAction.name(), SecurityRoles.Description.name())
059                        )))
060                )));
061        
062        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
063                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("ChainName", FieldType.ENTITY_NAME, true, null, null),
066                new FieldDefinition("ChainActionSetName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("ChainActionName", FieldType.ENTITY_NAME, true, null, null),
068                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
069                ));
070    }
071    
072    /** Creates a new instance of GetChainActionDescriptionCommand */
073    public GetChainActionDescriptionCommand(UserVisitPK userVisitPK, GetChainActionDescriptionForm form) {
074        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
075    }
076    
077    @Override
078    protected BaseResult execute() {
079        var chainControl = Session.getModelController(ChainControl.class);
080        GetChainActionDescriptionResult result = ChainResultFactory.getGetChainActionDescriptionResult();
081        String chainKindName = form.getChainKindName();
082        ChainKind chainKind = chainControl.getChainKindByName(chainKindName);
083
084        if(chainKind != null) {
085            String chainTypeName = form.getChainTypeName();
086            ChainType chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
087
088            if(chainType != null) {
089                String chainName = form.getChainName();
090                Chain chain = chainControl.getChainByName(chainType, chainName);
091
092                if(chain != null) {
093                    String chainActionSetName = form.getChainActionSetName();
094                    ChainActionSet chainActionSet = chainControl.getChainActionSetByName(chain, chainActionSetName);
095
096                    if(chainActionSet != null) {
097                        String chainActionName = form.getChainActionName();
098                        ChainAction chainAction = chainControl.getChainActionByName(chainActionSet, chainActionName);
099
100                        if(chainAction != null) {
101                            var partyControl = Session.getModelController(PartyControl.class);
102                            String languageIsoName = form.getLanguageIsoName();
103                            Language language = partyControl.getLanguageByIsoName(languageIsoName);
104
105                            if(language != null) {
106                                ChainActionDescription chainActionDescription = chainControl.getChainActionDescription(chainAction, language);
107
108                                if(chainActionDescription != null) {
109                                    result.setChainActionDescription(chainControl.getChainActionDescriptionTransfer(getUserVisit(), chainActionDescription));
110                                } else {
111                                    addExecutionError(ExecutionErrors.UnknownChainActionDescription.name(), chainKindName, chainTypeName, chainName,
112                                            chainActionSetName, chainActionName, languageIsoName);
113                                }
114                            } else {
115                                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
116                            }
117                        } else {
118                            addExecutionError(ExecutionErrors.UnknownChainActionName.name(), chainKindName, chainTypeName, chainName, chainActionSetName, chainActionName);
119                        }
120                    } else {
121                        addExecutionError(ExecutionErrors.UnknownChainActionSetName.name(), chainKindName, chainTypeName, chainName, chainActionSetName);
122                    }
123                } else {
124                    addExecutionError(ExecutionErrors.UnknownChainName.name(), chainKindName, chainTypeName, chainName);
125                }
126            } else {
127                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainKindName, chainTypeName);
128            }
129        } else {
130            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
131        }
132        
133        return result;
134    }
135    
136}