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.edit.CampaignEdit;
020import com.echothree.control.user.campaign.common.edit.CampaignEditFactory;
021import com.echothree.control.user.campaign.common.form.EditCampaignForm;
022import com.echothree.control.user.campaign.common.result.CampaignResultFactory;
023import com.echothree.control.user.campaign.common.result.EditCampaignResult;
024import com.echothree.control.user.campaign.common.spec.CampaignSpec;
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.Campaign;
030import com.echothree.model.data.campaign.server.entity.CampaignDescription;
031import com.echothree.model.data.campaign.server.entity.CampaignDetail;
032import com.echothree.model.data.campaign.server.value.CampaignDescriptionValue;
033import com.echothree.model.data.campaign.server.value.CampaignDetailValue;
034import com.echothree.model.data.user.common.pk.UserVisitPK;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.validation.FieldDefinition;
037import com.echothree.util.common.validation.FieldType;
038import com.echothree.util.common.command.EditMode;
039import com.echothree.util.server.control.BaseAbstractEditCommand;
040import com.echothree.util.server.control.CommandSecurityDefinition;
041import com.echothree.util.server.control.PartyTypeDefinition;
042import com.echothree.util.server.control.SecurityRoleDefinition;
043import com.echothree.util.server.persistence.Session;
044import java.util.Arrays;
045import java.util.Collections;
046import java.util.List;
047
048public class EditCampaignCommand
049        extends BaseAbstractEditCommand<CampaignSpec, CampaignEdit, EditCampaignResult, Campaign, Campaign> {
050    
051    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
052    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
053    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
054    
055    static {
056        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
057                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
058                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
059                        new SecurityRoleDefinition(SecurityRoleGroups.Campaign.name(), SecurityRoles.Edit.name())
060                        )))
061                )));
062        
063        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
064                new FieldDefinition("CampaignName", FieldType.ENTITY_NAME, true, null, null)
065                ));
066        
067        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
068                new FieldDefinition("Value", FieldType.STRING, true, null, null),
069                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
070                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
071                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
072                ));
073    }
074    
075    /** Creates a new instance of EditCampaignCommand */
076    public EditCampaignCommand(UserVisitPK userVisitPK, EditCampaignForm form) {
077        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
078    }
079    
080    @Override
081    public EditCampaignResult getResult() {
082        return CampaignResultFactory.getEditCampaignResult();
083    }
084
085    @Override
086    public CampaignEdit getEdit() {
087        return CampaignEditFactory.getCampaignEdit();
088    }
089
090    @Override
091    public Campaign getEntity(EditCampaignResult result) {
092        var campaignControl = Session.getModelController(CampaignControl.class);
093        Campaign campaign;
094        String campaignName = spec.getCampaignName();
095
096        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
097            campaign = campaignControl.getCampaignByName(campaignName);
098        } else { // EditMode.UPDATE
099            campaign = campaignControl.getCampaignByNameForUpdate(campaignName);
100        }
101
102        if(campaign == null) {
103            addExecutionError(ExecutionErrors.UnknownCampaignName.name(), campaignName);
104        }
105
106        return campaign;
107    }
108
109    @Override
110    public Campaign getLockEntity(Campaign campaign) {
111        return campaign;
112    }
113
114    @Override
115    public void fillInResult(EditCampaignResult result, Campaign campaign) {
116        var campaignControl = Session.getModelController(CampaignControl.class);
117
118        result.setCampaign(campaignControl.getCampaignTransfer(getUserVisit(), campaign));
119    }
120
121    @Override
122    public void doLock(CampaignEdit edit, Campaign campaign) {
123        var campaignControl = Session.getModelController(CampaignControl.class);
124        CampaignDescription campaignDescription = campaignControl.getCampaignDescription(campaign, getPreferredLanguage());
125        CampaignDetail campaignDetail = campaign.getLastDetail();
126
127        edit.setValue(campaignDetail.getValue());
128        edit.setIsDefault(campaignDetail.getIsDefault().toString());
129        edit.setSortOrder(campaignDetail.getSortOrder().toString());
130
131        if(campaignDescription != null) {
132            edit.setDescription(campaignDescription.getDescription());
133        }
134    }
135
136    @Override
137    public void canUpdate(Campaign campaign) {
138        var campaignControl = Session.getModelController(CampaignControl.class);
139        String value = edit.getValue();
140        Campaign duplicateCampaign = campaignControl.getCampaignByValue(value);
141
142        if(duplicateCampaign != null && !campaign.equals(duplicateCampaign)) {
143            addExecutionError(ExecutionErrors.DuplicateCampaignValue.name(), value);
144        }
145    }
146
147    @Override
148    public void doUpdate(Campaign campaign) {
149        var campaignControl = Session.getModelController(CampaignControl.class);
150        var partyPK = getPartyPK();
151        CampaignDetailValue campaignDetailValue = campaignControl.getCampaignDetailValueForUpdate(campaign);
152        CampaignDescription campaignDescription = campaignControl.getCampaignDescriptionForUpdate(campaign, getPreferredLanguage());
153        String description = edit.getDescription();
154
155        campaignDetailValue.setValue(edit.getValue());
156        campaignDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
157        campaignDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
158
159        campaignControl.updateCampaignFromValue(campaignDetailValue, partyPK);
160
161        if(campaignDescription == null && description != null) {
162            campaignControl.createCampaignDescription(campaign, getPreferredLanguage(), description, partyPK);
163        } else {
164            if(campaignDescription != null && description == null) {
165                campaignControl.deleteCampaignDescription(campaignDescription, partyPK);
166            } else {
167                if(campaignDescription != null && description != null) {
168                    CampaignDescriptionValue campaignDescriptionValue = campaignControl.getCampaignDescriptionValue(campaignDescription);
169
170                    campaignDescriptionValue.setDescription(description);
171                    campaignControl.updateCampaignDescriptionFromValue(campaignDescriptionValue, partyPK);
172                }
173            }
174        }
175    }
176    
177}