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.CampaignDescriptionEdit;
020import com.echothree.control.user.campaign.common.edit.CampaignEditFactory;
021import com.echothree.control.user.campaign.common.form.EditCampaignDescriptionForm;
022import com.echothree.control.user.campaign.common.result.CampaignResultFactory;
023import com.echothree.control.user.campaign.common.result.EditCampaignDescriptionResult;
024import com.echothree.control.user.campaign.common.spec.CampaignDescriptionSpec;
025import com.echothree.model.control.campaign.server.control.CampaignControl;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.party.server.control.PartyControl;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.campaign.server.entity.Campaign;
031import com.echothree.model.data.campaign.server.entity.CampaignDescription;
032import com.echothree.model.data.campaign.server.value.CampaignDescriptionValue;
033import com.echothree.model.data.party.server.entity.Language;
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 EditCampaignDescriptionCommand
049        extends BaseAbstractEditCommand<CampaignDescriptionSpec, CampaignDescriptionEdit, EditCampaignDescriptionResult, CampaignDescription, 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.Description.name())
060                        )))
061                )));
062        
063        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
064                new FieldDefinition("CampaignName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
066                ));
067        
068        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
069                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
070                ));
071    }
072    
073    /** Creates a new instance of EditCampaignDescriptionCommand */
074    public EditCampaignDescriptionCommand(UserVisitPK userVisitPK, EditCampaignDescriptionForm form) {
075        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
076    }
077    
078    @Override
079    public EditCampaignDescriptionResult getResult() {
080        return CampaignResultFactory.getEditCampaignDescriptionResult();
081    }
082
083    @Override
084    public CampaignDescriptionEdit getEdit() {
085        return CampaignEditFactory.getCampaignDescriptionEdit();
086    }
087
088    @Override
089    public CampaignDescription getEntity(EditCampaignDescriptionResult result) {
090        var campaignControl = Session.getModelController(CampaignControl.class);
091        CampaignDescription campaignDescription = null;
092        String campaignName = spec.getCampaignName();
093        Campaign campaign = campaignControl.getCampaignByName(campaignName);
094
095        if(campaign != null) {
096            var partyControl = Session.getModelController(PartyControl.class);
097            String languageIsoName = spec.getLanguageIsoName();
098            Language language = partyControl.getLanguageByIsoName(languageIsoName);
099
100            if(language != null) {
101                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
102                    campaignDescription = campaignControl.getCampaignDescription(campaign, language);
103                } else { // EditMode.UPDATE
104                    campaignDescription = campaignControl.getCampaignDescriptionForUpdate(campaign, language);
105                }
106
107                if(campaignDescription == null) {
108                    addExecutionError(ExecutionErrors.UnknownCampaignDescription.name(), campaignName, languageIsoName);
109                }
110            } else {
111                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
112            }
113        } else {
114            addExecutionError(ExecutionErrors.UnknownCampaignName.name(), campaignName);
115        }
116
117        return campaignDescription;
118    }
119
120    @Override
121    public Campaign getLockEntity(CampaignDescription campaignDescription) {
122        return campaignDescription.getCampaign();
123    }
124
125    @Override
126    public void fillInResult(EditCampaignDescriptionResult result, CampaignDescription campaignDescription) {
127        var campaignControl = Session.getModelController(CampaignControl.class);
128
129        result.setCampaignDescription(campaignControl.getCampaignDescriptionTransfer(getUserVisit(), campaignDescription));
130    }
131
132    @Override
133    public void doLock(CampaignDescriptionEdit edit, CampaignDescription campaignDescription) {
134        edit.setDescription(campaignDescription.getDescription());
135    }
136
137    @Override
138    public void doUpdate(CampaignDescription campaignDescription) {
139        var campaignControl = Session.getModelController(CampaignControl.class);
140        CampaignDescriptionValue campaignDescriptionValue = campaignControl.getCampaignDescriptionValue(campaignDescription);
141        campaignDescriptionValue.setDescription(edit.getDescription());
142
143        campaignControl.updateCampaignDescriptionFromValue(campaignDescriptionValue, getPartyPK());
144    }
145    
146}