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.CreateCampaignTermForm;
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.model.data.user.common.pk.UserVisitPK;
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.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037
038@Dependent
039public class CreateCampaignTermCommand
040        extends BaseSimpleCommand<CreateCampaignTermForm> {
041    
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.CampaignTerm.name(), SecurityRoles.Create.name())
050                        ))
051                ));
052        
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("Value", FieldType.STRING, true, null, null),
055                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
056                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
057                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
058                );
059    }
060    
061    /** Creates a new instance of CreateCampaignTermCommand */
062    public CreateCampaignTermCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var result = CampaignResultFactory.getCreateCampaignTermResult();
069        var campaignControl = Session.getModelController(CampaignControl.class);
070        var value = form.getValue();
071        var campaignTerm = campaignControl.getCampaignTermByValue(value);
072        
073        if(campaignTerm == null) {
074            var partyPK = getPartyPK();
075            var isDefault = Boolean.valueOf(form.getIsDefault());
076            var sortOrder = Integer.valueOf(form.getSortOrder());
077            var description = form.getDescription();
078            
079            campaignTerm = campaignControl.createCampaignTerm(value, isDefault, sortOrder, partyPK);
080            
081            if(description != null) {
082                campaignControl.createCampaignTermDescription(campaignTerm, getPreferredLanguage(), description, partyPK);
083            }
084        } else {
085            addExecutionError(ExecutionErrors.DuplicateCampaignTermValue.name(), value);
086        }
087        
088        result.setCampaignTermName(campaignTerm.getLastDetail().getCampaignTermName());
089        
090        return result;
091    }
092    
093}