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.CreateCampaignForm;
020import com.echothree.control.user.campaign.common.result.CampaignResultFactory;
021import com.echothree.control.user.campaign.common.result.CreateCampaignResult;
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.Campaign;
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 CreateCampaignCommand
042        extends BaseSimpleCommand<CreateCampaignForm> {
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.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
051                        new SecurityRoleDefinition(SecurityRoleGroups.Campaign.name(), SecurityRoles.Create.name())
052                        )))
053                )));
054        
055        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
056                new FieldDefinition("Value", FieldType.STRING, true, null, null),
057                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
058                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
059                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
060                ));
061    }
062    
063    /** Creates a new instance of CreateCampaignCommand */
064    public CreateCampaignCommand(UserVisitPK userVisitPK, CreateCampaignForm form) {
065        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        CreateCampaignResult result = CampaignResultFactory.getCreateCampaignResult();
071        var campaignControl = Session.getModelController(CampaignControl.class);
072        String value = form.getValue();
073        Campaign campaign = campaignControl.getCampaignByValue(value);
074        
075        if(campaign == null) {
076            var partyPK = getPartyPK();
077            var isDefault = Boolean.valueOf(form.getIsDefault());
078            var sortOrder = Integer.valueOf(form.getSortOrder());
079            var description = form.getDescription();
080            
081            campaign = campaignControl.createCampaign(value, isDefault, sortOrder, partyPK);
082            
083            if(description != null) {
084                campaignControl.createCampaignDescription(campaign, getPreferredLanguage(), description, partyPK);
085            }
086        } else {
087            addExecutionError(ExecutionErrors.DuplicateCampaignValue.name(), value);
088        }
089        
090        result.setCampaignName(campaign.getLastDetail().getCampaignName());
091        
092        return result;
093    }
094    
095}