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