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