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.GetChainActionSetForm;
020import com.echothree.control.user.chain.common.result.ChainResultFactory;
021import com.echothree.control.user.chain.common.result.GetChainActionSetResult;
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.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 GetChainActionSetCommand
046        extends BaseSimpleCommand<GetChainActionSetForm> {
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.ChainActionSet.name(), SecurityRoles.Review.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                ));
065    }
066    
067    /** Creates a new instance of GetChainActionSetCommand */
068    public GetChainActionSetCommand(UserVisitPK userVisitPK, GetChainActionSetForm form) {
069        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
070    }
071    
072    @Override
073    protected BaseResult execute() {
074        var chainControl = Session.getModelController(ChainControl.class);
075        GetChainActionSetResult result = ChainResultFactory.getGetChainActionSetResult();
076        String chainKindName = form.getChainKindName();
077        ChainKind chainKind = chainControl.getChainKindByName(chainKindName);
078        
079        if(chainKind != null) {
080            String chainTypeName = form.getChainTypeName();
081            ChainType chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
082
083            if(chainType != null) {
084                String chainName = form.getChainName();
085                Chain chain = chainControl.getChainByName(chainType, chainName);
086
087                if(chain != null) {
088                    String chainActionSetName = form.getChainActionSetName();
089                    ChainActionSet chainActionSet = chainControl.getChainActionSetByName(chain, chainActionSetName);
090
091                    if(chainActionSet != null) {
092                        result.setChainActionSet(chainControl.getChainActionSetTransfer(getUserVisit(), chainActionSet));
093
094                        sendEvent(chainActionSet.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
095                    } else {
096                        addExecutionError(ExecutionErrors.UnknownChainActionSetName.name(), chainKindName, chainTypeName, chainName, chainActionSetName);
097                    }
098                } else {
099                    addExecutionError(ExecutionErrors.UnknownChainName.name(), chainKindName, chainTypeName, chainName);
100                }
101            } else {
102                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainKindName, chainTypeName);
103            }
104        } else {
105            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
106        }
107        
108        return result;
109    }
110    
111}