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