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.campaign.server.command;
018
019import com.echothree.control.user.campaign.common.form.GetCampaignTermStatusChoicesForm;
020import com.echothree.control.user.campaign.common.result.CampaignResultFactory;
021import com.echothree.control.user.campaign.common.result.GetCampaignTermStatusChoicesResult;
022import com.echothree.model.control.campaign.server.control.CampaignControl;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.campaign.server.entity.CampaignTerm;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.server.control.BaseSimpleCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import com.echothree.util.server.persistence.Session;
037import java.util.Arrays;
038import java.util.Collections;
039import java.util.List;
040
041public class GetCampaignTermStatusChoicesCommand
042        extends BaseSimpleCommand<GetCampaignTermStatusChoicesForm> {
043    
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
050                    new SecurityRoleDefinition(SecurityRoleGroups.CampaignTermStatus.name(), SecurityRoles.Choices.name())
051                    )))
052                )));
053        
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055            new FieldDefinition("CampaignTermName", FieldType.ENTITY_NAME, false, null, null),
056            new FieldDefinition("DefaultCampaignTermStatusChoice", FieldType.ENTITY_NAME, false, null, null),
057            new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
058        ));
059    }
060    
061    /** Creates a new instance of GetCampaignTermStatusChoicesCommand */
062    public GetCampaignTermStatusChoicesCommand(UserVisitPK userVisitPK, GetCampaignTermStatusChoicesForm form) {
063        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var campaignControl = Session.getModelController(CampaignControl.class);
069        GetCampaignTermStatusChoicesResult result = CampaignResultFactory.getGetCampaignTermStatusChoicesResult();
070        String campaignTermName = form.getCampaignTermName();
071        CampaignTerm campaignTerm = campaignControl.getCampaignTermByName(campaignTermName);
072        
073        if(campaignTerm != null) {
074            String defaultCampaignTermStatusChoice = form.getDefaultCampaignTermStatusChoice();
075            boolean allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
076            
077            result.setCampaignTermStatusChoices(campaignControl.getCampaignTermStatusChoices(defaultCampaignTermStatusChoice,
078                    getPreferredLanguage(), allowNullChoice, campaignTerm, getPartyPK()));
079        } else {
080            addExecutionError(ExecutionErrors.UnknownCampaignTermName.name(), campaignTermName);
081        }
082        
083        return result;
084    }
085    
086}