001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.edit.CampaignEditFactory;
020import com.echothree.control.user.campaign.common.edit.CampaignMediumEdit;
021import com.echothree.control.user.campaign.common.form.EditCampaignMediumForm;
022import com.echothree.control.user.campaign.common.result.CampaignResultFactory;
023import com.echothree.control.user.campaign.common.result.EditCampaignMediumResult;
024import com.echothree.control.user.campaign.common.spec.CampaignMediumSpec;
025import com.echothree.model.control.campaign.server.control.CampaignControl;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.campaign.server.entity.CampaignMedium;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.EditMode;
035import com.echothree.util.server.control.BaseAbstractEditCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.Arrays;
041import java.util.Collections;
042import java.util.List;
043import javax.enterprise.context.RequestScoped;
044
045@RequestScoped
046public class EditCampaignMediumCommand
047        extends BaseAbstractEditCommand<CampaignMediumSpec, CampaignMediumEdit, EditCampaignMediumResult, CampaignMedium, CampaignMedium> {
048    
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
051    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
052    
053    static {
054        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
057                        new SecurityRoleDefinition(SecurityRoleGroups.CampaignMedium.name(), SecurityRoles.Edit.name())
058                        )))
059                )));
060        
061        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
062                new FieldDefinition("CampaignMediumName", FieldType.ENTITY_NAME, true, null, null)
063                ));
064        
065        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
066                new FieldDefinition("Value", FieldType.STRING, true, null, null),
067                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
068                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
069                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
070                ));
071    }
072    
073    /** Creates a new instance of EditCampaignMediumCommand */
074    public EditCampaignMediumCommand() {
075        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
076    }
077    
078    @Override
079    public EditCampaignMediumResult getResult() {
080        return CampaignResultFactory.getEditCampaignMediumResult();
081    }
082
083    @Override
084    public CampaignMediumEdit getEdit() {
085        return CampaignEditFactory.getCampaignMediumEdit();
086    }
087
088    @Override
089    public CampaignMedium getEntity(EditCampaignMediumResult result) {
090        var campaignControl = Session.getModelController(CampaignControl.class);
091        CampaignMedium campaignMedium;
092        var campaignMediumName = spec.getCampaignMediumName();
093
094        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
095            campaignMedium = campaignControl.getCampaignMediumByName(campaignMediumName);
096        } else { // EditMode.UPDATE
097            campaignMedium = campaignControl.getCampaignMediumByNameForUpdate(campaignMediumName);
098        }
099
100        if(campaignMedium == null) {
101            addExecutionError(ExecutionErrors.UnknownCampaignMediumName.name(), campaignMediumName);
102        }
103
104        return campaignMedium;
105    }
106
107    @Override
108    public CampaignMedium getLockEntity(CampaignMedium campaignMedium) {
109        return campaignMedium;
110    }
111
112    @Override
113    public void fillInResult(EditCampaignMediumResult result, CampaignMedium campaignMedium) {
114        var campaignControl = Session.getModelController(CampaignControl.class);
115
116        result.setCampaignMedium(campaignControl.getCampaignMediumTransfer(getUserVisit(), campaignMedium));
117    }
118
119    @Override
120    public void doLock(CampaignMediumEdit edit, CampaignMedium campaignMedium) {
121        var campaignControl = Session.getModelController(CampaignControl.class);
122        var campaignMediumDescription = campaignControl.getCampaignMediumDescription(campaignMedium, getPreferredLanguage());
123        var campaignMediumDetail = campaignMedium.getLastDetail();
124
125        edit.setValue(campaignMediumDetail.getValue());
126        edit.setIsDefault(campaignMediumDetail.getIsDefault().toString());
127        edit.setSortOrder(campaignMediumDetail.getSortOrder().toString());
128
129        if(campaignMediumDescription != null) {
130            edit.setDescription(campaignMediumDescription.getDescription());
131        }
132    }
133
134    @Override
135    public void canUpdate(CampaignMedium campaignMedium) {
136        var campaignControl = Session.getModelController(CampaignControl.class);
137        var value = edit.getValue();
138        var duplicateCampaignMedium = campaignControl.getCampaignMediumByValue(value);
139
140        if(duplicateCampaignMedium != null && !campaignMedium.equals(duplicateCampaignMedium)) {
141            addExecutionError(ExecutionErrors.DuplicateCampaignMediumValue.name(), value);
142        }
143    }
144
145    @Override
146    public void doUpdate(CampaignMedium campaignMedium) {
147        var campaignControl = Session.getModelController(CampaignControl.class);
148        var partyPK = getPartyPK();
149        var campaignMediumDetailValue = campaignControl.getCampaignMediumDetailValueForUpdate(campaignMedium);
150        var campaignMediumDescription = campaignControl.getCampaignMediumDescriptionForUpdate(campaignMedium, getPreferredLanguage());
151        var description = edit.getDescription();
152
153        campaignMediumDetailValue.setValue(edit.getValue());
154        campaignMediumDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
155        campaignMediumDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
156
157        campaignControl.updateCampaignMediumFromValue(campaignMediumDetailValue, partyPK);
158
159        if(campaignMediumDescription == null && description != null) {
160            campaignControl.createCampaignMediumDescription(campaignMedium, getPreferredLanguage(), description, partyPK);
161        } else {
162            if(campaignMediumDescription != null && description == null) {
163                campaignControl.deleteCampaignMediumDescription(campaignMediumDescription, partyPK);
164            } else {
165                if(campaignMediumDescription != null && description != null) {
166                    var campaignMediumDescriptionValue = campaignControl.getCampaignMediumDescriptionValue(campaignMediumDescription);
167
168                    campaignMediumDescriptionValue.setDescription(description);
169                    campaignControl.updateCampaignMediumDescriptionFromValue(campaignMediumDescriptionValue, partyPK);
170                }
171            }
172        }
173    }
174    
175}