001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.GetChainActionSetChoicesForm;
020import com.echothree.control.user.chain.common.result.ChainResultFactory;
021import com.echothree.model.control.chain.server.control.ChainControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.Arrays;
036import java.util.Collections;
037import java.util.List;
038import javax.enterprise.context.RequestScoped;
039
040@RequestScoped
041public class GetChainActionSetChoicesCommand
042        extends BaseSimpleCommand<GetChainActionSetChoicesForm> {
043    
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
050                    new SecurityRoleDefinition(SecurityRoleGroups.ChainActionSet.name(), SecurityRoles.Choices.name())
051                    )))
052                )));
053
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("ChainName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("DefaultChainActionSetChoice", FieldType.ENTITY_NAME, false, null, null),
059                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
060                ));
061    }
062    
063    /** Creates a new instance of GetChainActionSetChoicesCommand */
064    public GetChainActionSetChoicesCommand() {
065        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        var chainControl = Session.getModelController(ChainControl.class);
071        var result = ChainResultFactory.getGetChainActionSetChoicesResult();
072        var chainKindName = form.getChainKindName();
073        var chainKind = chainControl.getChainKindByName(chainKindName);
074        
075        if(chainKind != null) {
076            var chainTypeName = form.getChainTypeName();
077            var chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
078
079            if(chainType != null) {
080                var chainName = form.getChainName();
081                var chain = chainControl.getChainByName(chainType, chainName);
082
083                if(chain != null) {
084                    var defaultChainActionSetChoice = form.getDefaultChainActionSetChoice();
085                    var allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
086
087                    result.setChainActionSetChoices(chainControl.getChainActionSetChoices(defaultChainActionSetChoice, getPreferredLanguage(), allowNullChoice, chain));
088                } else {
089                    addExecutionError(ExecutionErrors.UnknownChainName.name(), chainKindName, chainTypeName, chainName);
090                }
091            } else {
092                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainKindName, chainTypeName);
093            }
094        } else {
095            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
096        }
097        
098        return result;
099    }
100    
101}