001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.icon.server.command;
018
019import com.echothree.control.user.icon.common.form.GetIconChoicesForm;
020import com.echothree.control.user.icon.common.result.IconResultFactory;
021import com.echothree.model.control.icon.server.control.IconControl;
022import com.echothree.model.data.user.common.pk.UserVisitPK;
023import com.echothree.util.common.message.ExecutionErrors;
024import com.echothree.util.common.validation.FieldDefinition;
025import com.echothree.util.common.validation.FieldType;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.server.control.BaseSimpleCommand;
028import com.echothree.util.server.persistence.Session;
029import java.util.List;
030import javax.enterprise.context.Dependent;
031
032@Dependent
033public class GetIconChoicesCommand
034        extends BaseSimpleCommand<GetIconChoicesForm> {
035    
036    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
037    
038    static {
039        FORM_FIELD_DEFINITIONS = List.of(
040            new FieldDefinition("IconUsageTypeName", FieldType.ENTITY_NAME, true, null, null),
041            new FieldDefinition("DefaultIconChoice", FieldType.ENTITY_NAME, false, null, null),
042            new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
043        );
044    }
045    
046    /** Creates a new instance of GetIconChoicesCommand */
047    public GetIconChoicesCommand() {
048        super(null, FORM_FIELD_DEFINITIONS, false);
049    }
050    
051    @Override
052    protected BaseResult execute() {
053        var iconControl = Session.getModelController(IconControl.class);
054        var result = IconResultFactory.getGetIconChoicesResult();
055        var iconUsageTypeName = form.getIconUsageTypeName();
056        var iconUsageType = iconControl.getIconUsageTypeByName(iconUsageTypeName);
057        
058        if(iconUsageType != null) {
059            var defaultIconChoice = form.getDefaultIconChoice();
060            var allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
061            
062            result.setIconChoices(iconControl.getIconChoicesByIconUsageType(iconUsageType, defaultIconChoice,
063                    getPreferredLanguage(), allowNullChoice));
064        } else {
065            addExecutionError(ExecutionErrors.UnknownIconUsageTypeName.name(), iconUsageTypeName);
066        }
067        
068        return result;
069    }
070    
071}