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