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.GetCampaignStatusChoicesForm;
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.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import com.echothree.util.server.persistence.Session;
034import java.util.List;
035import javax.enterprise.context.Dependent;
036
037@Dependent
038public class GetCampaignStatusChoicesCommand
039        extends BaseSimpleCommand<GetCampaignStatusChoicesForm> {
040    
041    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
042    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
043    
044    static {
045        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
046                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
047                        new SecurityRoleDefinition(SecurityRoleGroups.CampaignStatus.name(), SecurityRoles.Choices.name())
048                ))
049        ));
050        
051        FORM_FIELD_DEFINITIONS = List.of(
052                new FieldDefinition("CampaignName", FieldType.ENTITY_NAME, false, null, null),
053                new FieldDefinition("DefaultCampaignStatusChoice", FieldType.ENTITY_NAME, false, null, null),
054                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
055        );
056    }
057    
058    /** Creates a new instance of GetCampaignStatusChoicesCommand */
059    public GetCampaignStatusChoicesCommand() {
060        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
061    }
062    
063    @Override
064    protected BaseResult execute() {
065        var campaignControl = Session.getModelController(CampaignControl.class);
066        var result = CampaignResultFactory.getGetCampaignStatusChoicesResult();
067        var campaignName = form.getCampaignName();
068        var campaign = campaignControl.getCampaignByName(campaignName);
069        
070        if(campaign != null) {
071            var defaultCampaignStatusChoice = form.getDefaultCampaignStatusChoice();
072            var allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
073            
074            result.setCampaignStatusChoices(campaignControl.getCampaignStatusChoices(defaultCampaignStatusChoice,
075                    getPreferredLanguage(), allowNullChoice, campaign, getPartyPK()));
076        } else {
077            addExecutionError(ExecutionErrors.UnknownCampaignName.name(), campaignName);
078        }
079        
080        return result;
081    }
082    
083}