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.associate.server.command;
018
019import com.echothree.control.user.associate.common.form.GetAssociateChoicesForm;
020import com.echothree.control.user.associate.common.result.AssociateResultFactory;
021import com.echothree.control.user.associate.common.result.GetAssociateChoicesResult;
022import com.echothree.model.control.associate.server.control.AssociateControl;
023import com.echothree.model.data.associate.server.entity.AssociateProgram;
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 GetAssociateChoicesCommand
036        extends BaseSimpleCommand<GetAssociateChoicesForm> {
037    
038    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
039    
040    static {
041        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
042                new FieldDefinition("AssociateProgramName", FieldType.ENTITY_NAME, true, null, null),
043                new FieldDefinition("DefaultAssociateChoice", FieldType.ENTITY_NAME, false, null, null),
044                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
045                ));
046    }
047    
048    /** Creates a new instance of GetAssociateChoicesCommand */
049    public GetAssociateChoicesCommand(UserVisitPK userVisitPK, GetAssociateChoicesForm form) {
050        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, false);
051    }
052    
053    @Override
054    protected BaseResult execute() {
055        var associateControl = Session.getModelController(AssociateControl.class);
056        GetAssociateChoicesResult result = AssociateResultFactory.getGetAssociateChoicesResult();
057        String associateProgramName = form.getAssociateProgramName();
058        AssociateProgram associateProgram = associateControl.getAssociateProgramByName(associateProgramName);
059        
060        if(associateProgram != null) {
061            String defaultAssociateChoice = form.getDefaultAssociateChoice();
062            boolean allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
063            
064            result.setAssociateChoices(associateControl.getAssociateChoices(associateProgram, defaultAssociateChoice,
065                    getPreferredLanguage(), allowNullChoice));
066        } else {
067            addExecutionError(ExecutionErrors.UnknownAssociateProgramName.name(), associateProgramName);
068        }
069        
070        return result;
071    }
072    
073}