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.model.control.campaign.server.logic;
018
019import com.echothree.model.control.campaign.common.exception.UnknownCampaignTermNameException;
020import com.echothree.model.control.campaign.common.exception.UnknownCampaignTermStatusChoiceException;
021import com.echothree.model.control.campaign.common.exception.UnknownCampaignTermValueException;
022import com.echothree.model.control.campaign.server.control.CampaignControl;
023import com.echothree.model.control.core.server.control.CoreControl;
024import com.echothree.model.control.campaign.common.workflow.CampaignTermStatusConstants;
025import com.echothree.model.control.workflow.server.control.WorkflowControl;
026import com.echothree.model.control.workflow.server.logic.WorkflowDestinationLogic;
027import com.echothree.model.control.workflow.server.logic.WorkflowLogic;
028import com.echothree.model.data.campaign.server.entity.CampaignTerm;
029import com.echothree.model.data.core.server.entity.EntityInstance;
030import com.echothree.model.data.party.common.pk.PartyPK;
031import com.echothree.model.data.workflow.server.entity.Workflow;
032import com.echothree.model.data.workflow.server.entity.WorkflowDestination;
033import com.echothree.model.data.workflow.server.entity.WorkflowEntityStatus;
034import com.echothree.util.common.message.ExecutionErrors;
035import com.echothree.util.server.control.BaseLogic;
036import com.echothree.util.server.message.ExecutionErrorAccumulator;
037import com.echothree.util.server.persistence.Session;
038import java.util.Map;
039import java.util.Set;
040
041public class CampaignTermLogic
042        extends BaseLogic {
043
044    private CampaignTermLogic() {
045        super();
046    }
047
048    private static class CampaignTermLogicHolder {
049        static CampaignTermLogic instance = new CampaignTermLogic();
050    }
051
052    public static CampaignTermLogic getInstance() {
053        return CampaignTermLogicHolder.instance;
054    }
055    
056    public CampaignTerm getCampaignTermByName(final ExecutionErrorAccumulator eea, final String campaignTermName) {
057        var campaignControl = Session.getModelController(CampaignControl.class);
058        CampaignTerm campaignTerm = campaignControl.getCampaignTermByName(campaignTermName);
059
060        if(campaignTerm == null) {
061            handleExecutionError(UnknownCampaignTermNameException.class, eea, ExecutionErrors.UnknownCampaignTermName.name(), campaignTermName);
062        }
063
064        return campaignTerm;
065    }
066    
067    public CampaignTerm getCampaignTermByValue(final ExecutionErrorAccumulator eea, final String campaignTermValue) {
068        var campaignControl = Session.getModelController(CampaignControl.class);
069        CampaignTerm campaignTerm = campaignControl.getCampaignTermByValue(campaignTermValue);
070
071        if(campaignTerm == null) {
072            handleExecutionError(UnknownCampaignTermValueException.class, eea, ExecutionErrors.UnknownCampaignTermValue.name(), campaignTermValue);
073        }
074
075        return campaignTerm;
076    }
077    
078    public void setCampaignTermStatus(final Session session, ExecutionErrorAccumulator eea, CampaignTerm campaignTerm, String campaignTermStatusChoice, PartyPK modifiedBy) {
079        var coreControl = Session.getModelController(CoreControl.class);
080        var workflowControl = Session.getModelController(WorkflowControl.class);
081        var workflowLogic = WorkflowLogic.getInstance();
082        Workflow workflow = workflowLogic.getWorkflowByName(eea, CampaignTermStatusConstants.Workflow_CAMPAIGN_TERM_STATUS);
083        EntityInstance entityInstance = coreControl.getEntityInstanceByBasePK(campaignTerm.getPrimaryKey());
084        WorkflowEntityStatus workflowEntityStatus = workflowControl.getWorkflowEntityStatusByEntityInstanceForUpdate(workflow, entityInstance);
085        WorkflowDestination workflowDestination = campaignTermStatusChoice == null ? null : workflowControl.getWorkflowDestinationByName(workflowEntityStatus.getWorkflowStep(), campaignTermStatusChoice);
086
087        if(workflowDestination != null || campaignTermStatusChoice == null) {
088            WorkflowDestinationLogic workflowDestinationLogic = WorkflowDestinationLogic.getInstance();
089            String currentWorkflowStepName = workflowEntityStatus.getWorkflowStep().getLastDetail().getWorkflowStepName();
090            Map<String, Set<String>> map = workflowDestinationLogic.getWorkflowDestinationsAsMap(workflowDestination);
091            Long triggerTime = null;
092
093            if(currentWorkflowStepName.equals(CampaignTermStatusConstants.WorkflowStep_ACTIVE)) {
094                if(workflowDestinationLogic.workflowDestinationMapContainsStep(map, CampaignTermStatusConstants.Workflow_CAMPAIGN_TERM_STATUS, CampaignTermStatusConstants.WorkflowStep_INACTIVE)) {
095                    // Nothing at this time.
096                }
097            } else if(currentWorkflowStepName.equals(CampaignTermStatusConstants.WorkflowStep_INACTIVE)) {
098                if(workflowDestinationLogic.workflowDestinationMapContainsStep(map, CampaignTermStatusConstants.Workflow_CAMPAIGN_TERM_STATUS, CampaignTermStatusConstants.WorkflowStep_ACTIVE)) {
099                    // Nothing at this time.
100                }
101            }
102
103            if(eea == null || !eea.hasExecutionErrors()) {
104                workflowControl.transitionEntityInWorkflow(eea, workflowEntityStatus, workflowDestination, triggerTime, modifiedBy);
105            }
106        } else {
107            handleExecutionError(UnknownCampaignTermStatusChoiceException.class, eea, ExecutionErrors.UnknownCampaignTermStatusChoice.name(), campaignTermStatusChoice);
108        }
109    }
110
111}