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.form.GetCampaignMediumDescriptionForm;
020import com.echothree.control.user.campaign.common.result.CampaignResultFactory;
021import com.echothree.control.user.campaign.common.result.GetCampaignMediumDescriptionResult;
022import com.echothree.model.control.campaign.server.control.CampaignControl;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.party.server.control.PartyControl;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.campaign.server.entity.CampaignMedium;
028import com.echothree.model.data.campaign.server.entity.CampaignMediumDescription;
029import com.echothree.model.data.party.server.entity.Language;
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.BaseResult;
035import com.echothree.util.server.control.BaseSimpleCommand;
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;
043
044public class GetCampaignMediumDescriptionCommand
045        extends BaseSimpleCommand<GetCampaignMediumDescriptionForm> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
049    
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
054                        new SecurityRoleDefinition(SecurityRoleGroups.CampaignMedium.name(), SecurityRoles.Description.name())
055                        )))
056                )));
057        
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("CampaignMediumName", FieldType.ENTITY_NAME, true, null, null)
060                ));
061    }
062    
063    /** Creates a new instance of GetCampaignMediumDescriptionCommand */
064    public GetCampaignMediumDescriptionCommand(UserVisitPK userVisitPK, GetCampaignMediumDescriptionForm form) {
065        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        var campaignControl = Session.getModelController(CampaignControl.class);
071        GetCampaignMediumDescriptionResult result = CampaignResultFactory.getGetCampaignMediumDescriptionResult();
072        String campaignMediumName = form.getCampaignMediumName();
073        CampaignMedium campaignMedium = campaignControl.getCampaignMediumByName(campaignMediumName);
074
075        if(campaignMedium != null) {
076            var partyControl = Session.getModelController(PartyControl.class);
077            String languageIsoName = form.getLanguageIsoName();
078            Language language = partyControl.getLanguageByIsoName(languageIsoName);
079
080            if(language != null) {
081                CampaignMediumDescription campaignMediumDescription = campaignControl.getCampaignMediumDescription(campaignMedium, language);
082
083                if(campaignMediumDescription != null) {
084                    result.setCampaignMediumDescription(campaignControl.getCampaignMediumDescriptionTransfer(getUserVisit(), campaignMediumDescription));
085                } else {
086                    addExecutionError(ExecutionErrors.UnknownCampaignMediumDescription.name(), campaignMediumName, languageIsoName);
087                }
088            } else {
089                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
090            }
091        } else {
092            addExecutionError(ExecutionErrors.UnknownCampaignMediumName.name(), campaignMediumName);
093        }
094
095        return result;
096    }
097    
098}