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