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.campaign.server.command;
018
019import com.echothree.control.user.campaign.common.form.GetCampaignSourceChoicesForm;
020import com.echothree.control.user.campaign.common.result.CampaignResultFactory;
021import com.echothree.model.control.campaign.server.control.CampaignControl;
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.util.common.command.BaseResult;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.server.control.BaseSimpleCommand;
029import com.echothree.util.server.control.CommandSecurityDefinition;
030import com.echothree.util.server.control.PartyTypeDefinition;
031import com.echothree.util.server.control.SecurityRoleDefinition;
032import com.echothree.util.server.persistence.Session;
033import java.util.List;
034import javax.enterprise.context.Dependent;
035
036@Dependent
037public class GetCampaignSourceChoicesCommand
038        extends BaseSimpleCommand<GetCampaignSourceChoicesForm> {
039    
040    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
041    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
042    
043    static {
044        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
045                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
046                        new SecurityRoleDefinition(SecurityRoleGroups.CampaignSource.name(), SecurityRoles.Choices.name())
047                ))
048        ));
049        
050        FORM_FIELD_DEFINITIONS = List.of(
051                new FieldDefinition("DefaultCampaignSourceChoice", FieldType.ENTITY_NAME, false, null, null),
052                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
053        );
054    }
055    
056    /** Creates a new instance of GetCampaignSourceChoicesCommand */
057    public GetCampaignSourceChoicesCommand() {
058        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
059    }
060    
061    @Override
062    protected BaseResult execute() {
063        var campaignControl = Session.getModelController(CampaignControl.class);
064        var result = CampaignResultFactory.getGetCampaignSourceChoicesResult();
065        var defaultCampaignSourceChoice = form.getDefaultCampaignSourceChoice();
066        var allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
067        
068        result.setCampaignSourceChoices(campaignControl.getCampaignSourceChoices(defaultCampaignSourceChoice, getPreferredLanguage(), allowNullChoice));
069        
070        return result;
071    }
072    
073}