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.CreateCampaignForm;
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 java.util.List;
034import javax.enterprise.context.Dependent;
035import javax.inject.Inject;
036
037@Dependent
038public class CreateCampaignCommand
039        extends BaseSimpleCommand<CreateCampaignForm> {
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.UTILITY.name(), null),
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
048                        new SecurityRoleDefinition(SecurityRoleGroups.Campaign.name(), SecurityRoles.Create.name())
049                ))
050        ));
051
052        FORM_FIELD_DEFINITIONS = List.of(
053                new FieldDefinition("Value", FieldType.STRING, true, null, null),
054                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
055                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
056                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
057        );
058    }
059
060    @Inject
061    CampaignControl campaignControl;
062
063    /** Creates a new instance of CreateCampaignCommand */
064    public CreateCampaignCommand() {
065        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
066    }
067
068    @Override
069    protected BaseResult execute() {
070        var result = CampaignResultFactory.getCreateCampaignResult();
071        var value = form.getValue();
072        var campaign = campaignControl.getCampaignByValue(value);
073
074        if(campaign == null) {
075            var partyPK = getPartyPK();
076            var isDefault = Boolean.valueOf(form.getIsDefault());
077            var sortOrder = Integer.valueOf(form.getSortOrder());
078            var description = form.getDescription();
079
080            campaign = campaignControl.createCampaign(value, isDefault, sortOrder, partyPK);
081
082            if(description != null) {
083                campaignControl.createCampaignDescription(campaign, getPreferredLanguage(), description, partyPK);
084            }
085        } else {
086            addExecutionError(ExecutionErrors.DuplicateCampaignValue.name(), value);
087        }
088
089        if(campaign != null) {
090            result.setCampaignName(campaign.getLastDetail().getCampaignName());
091            result.setEntityRef(campaign.getPrimaryKey().getEntityRef());
092        }
093
094        return result;
095    }
096
097}