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.selector.server.command;
018
019import com.echothree.control.user.selector.common.form.GetSelectorNodeChoicesForm;
020import com.echothree.control.user.selector.common.result.GetSelectorNodeChoicesResult;
021import com.echothree.control.user.selector.common.result.SelectorResultFactory;
022import com.echothree.model.control.selector.server.control.SelectorControl;
023import com.echothree.model.data.party.server.entity.Language;
024import com.echothree.model.data.selector.server.entity.Selector;
025import com.echothree.model.data.selector.server.entity.SelectorKind;
026import com.echothree.model.data.selector.server.entity.SelectorType;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.server.control.BaseSimpleCommand;
033import com.echothree.util.server.persistence.Session;
034import java.util.Arrays;
035import java.util.Collections;
036import java.util.List;
037
038public class GetSelectorNodeChoicesCommand
039        extends BaseSimpleCommand<GetSelectorNodeChoicesForm> {
040    
041    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
042    
043    static {
044        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
045            new FieldDefinition("SelectorKindName", FieldType.ENTITY_NAME, true, null, null),
046            new FieldDefinition("SelectorTypeName", FieldType.ENTITY_NAME, true, null, null),
047            new FieldDefinition("SelectorName", FieldType.ENTITY_NAME, true, null, null),
048            new FieldDefinition("DefaultSelectorNodeChoice", FieldType.ENTITY_NAME, false, null, null),
049            new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
050        ));
051    }
052    
053    /** Creates a new instance of GetSelectorNodeChoicesCommand */
054    public GetSelectorNodeChoicesCommand(UserVisitPK userVisitPK, GetSelectorNodeChoicesForm form) {
055        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, false);
056    }
057    
058    @Override
059    protected BaseResult execute() {
060        var selectorControl = Session.getModelController(SelectorControl.class);
061        GetSelectorNodeChoicesResult result = SelectorResultFactory.getGetSelectorNodeChoicesResult();
062        String selectorKindName = form.getSelectorKindName();
063        SelectorKind selectorKind = selectorControl.getSelectorKindByName(selectorKindName);
064        
065        if(selectorKind != null) {
066            String selectorTypeName = form.getSelectorTypeName();
067            SelectorType selectorType = selectorControl.getSelectorTypeByName(selectorKind, selectorTypeName);
068            
069            if(selectorType != null) {
070                String selectorName = form.getSelectorName();
071                Selector selector = selectorControl.getSelectorByName(selectorType, selectorName);
072                
073                if(selector != null) {
074                    String defaultSelectorNodeChoice = form.getDefaultSelectorNodeChoice();
075                    Language language = getPreferredLanguage();
076                    boolean allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
077                    
078                    result.setSelectorNodeChoices(selectorControl.getSelectorNodeChoices(selector, defaultSelectorNodeChoice,
079                            language, allowNullChoice));
080                } else {
081                    addExecutionError(ExecutionErrors.UnknownSelectorName.name(), selectorName);
082                }
083            } else {
084                addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), selectorTypeName);
085            }
086        } else {
087            addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), selectorKindName);
088        }
089        
090        return result;
091    }
092    
093}