001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.control.user.campaign.common.spec.CampaignTermUniversalSpec;
020import com.echothree.model.control.campaign.common.exception.UnknownCampaignTermNameException;
021import com.echothree.model.control.campaign.common.exception.UnknownCampaignTermStatusChoiceException;
022import com.echothree.model.control.campaign.common.exception.UnknownCampaignTermValueException;
023import com.echothree.model.control.campaign.common.workflow.CampaignTermStatusConstants;
024import com.echothree.model.control.campaign.server.control.CampaignControl;
025import com.echothree.model.control.core.common.ComponentVendors;
026import com.echothree.model.control.core.common.EntityTypes;
027import com.echothree.model.control.core.common.exception.InvalidParameterCountException;
028import com.echothree.model.control.core.server.control.EntityInstanceControl;
029import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
030import com.echothree.model.control.workflow.server.control.WorkflowControl;
031import com.echothree.model.control.workflow.server.logic.WorkflowDestinationLogic;
032import com.echothree.model.control.workflow.server.logic.WorkflowLogic;
033import com.echothree.model.data.campaign.server.entity.CampaignTerm;
034import com.echothree.model.data.party.common.pk.PartyPK;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.server.control.BaseLogic;
037import com.echothree.util.server.message.ExecutionErrorAccumulator;
038import com.echothree.util.server.persistence.EntityPermission;
039import com.echothree.util.server.persistence.Session;
040import javax.enterprise.context.ApplicationScoped;
041import javax.enterprise.inject.spi.CDI;
042import javax.inject.Inject;
043
044@ApplicationScoped
045public class CampaignTermLogic
046        extends BaseLogic {
047
048    protected CampaignTermLogic() {
049        super();
050    }
051
052    public static CampaignTermLogic getInstance() {
053        return CDI.current().select(CampaignTermLogic.class).get();
054    }
055
056    @Inject
057    CampaignControl campaignControl;
058
059    public CampaignTerm getCampaignTermByName(final ExecutionErrorAccumulator eea, final String campaignTermName,
060            final EntityPermission entityPermission) {
061        var campaignTerm = campaignControl.getCampaignTermByName(campaignTermName, entityPermission);
062
063        if(campaignTerm == null) {
064            handleExecutionError(UnknownCampaignTermNameException.class, eea, ExecutionErrors.UnknownCampaignTermName.name(), campaignTermName);
065        }
066
067        return campaignTerm;
068    }
069
070    public CampaignTerm getCampaignTermByName(final ExecutionErrorAccumulator eea, final String campaignTermName) {
071        return getCampaignTermByName(eea, campaignTermName, EntityPermission.READ_ONLY);
072    }
073
074    public CampaignTerm getCampaignTermByNameForUpdate(final ExecutionErrorAccumulator eea, final String campaignTermName) {
075        return getCampaignTermByName(eea, campaignTermName, EntityPermission.READ_WRITE);
076    }
077
078    public CampaignTerm getCampaignTermByValue(final ExecutionErrorAccumulator eea, final String campaignTermValue,
079            final EntityPermission entityPermission) {
080        var campaignTerm = campaignControl.getCampaignTermByValue(campaignTermValue, entityPermission);
081
082        if(campaignTerm == null) {
083            handleExecutionError(UnknownCampaignTermValueException.class, eea, ExecutionErrors.UnknownCampaignTermValue.name(), campaignTermValue);
084        }
085
086        return campaignTerm;
087    }
088
089    public CampaignTerm getCampaignTermByValue(final ExecutionErrorAccumulator eea, final String campaignTermValue) {
090        return getCampaignTermByValue(eea, campaignTermValue, EntityPermission.READ_ONLY);
091    }
092
093    public CampaignTerm getCampaignTermByValueForUpdate(final ExecutionErrorAccumulator eea, final String campaignTermValue) {
094        return getCampaignTermByValue(eea, campaignTermValue, EntityPermission.READ_WRITE);
095    }
096
097    public CampaignTerm getCampaignTermByUniversalSpec(final ExecutionErrorAccumulator eea,
098            final CampaignTermUniversalSpec universalSpec, final EntityPermission entityPermission) {
099        CampaignTerm campaignTerm = null;
100        var campaignTermName = universalSpec.getCampaignTermName();
101        var parameterCount = (campaignTermName == null ? 0 : 1) + EntityInstanceLogic.getInstance().countPossibleEntitySpecs(universalSpec);
102
103        switch(parameterCount) {
104            case 1 -> {
105                if(campaignTermName == null) {
106                    var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(eea, universalSpec,
107                            ComponentVendors.ECHO_THREE.name(), EntityTypes.CampaignTerm.name());
108
109                    if(eea == null || !eea.hasExecutionErrors()) {
110                        campaignTerm = campaignControl.getCampaignTermByEntityInstance(entityInstance, entityPermission);
111                    }
112                } else {
113                    campaignTerm = getCampaignTermByName(eea, campaignTermName, entityPermission);
114                }
115            }
116            default ->
117                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
118        }
119
120        return campaignTerm;
121    }
122
123    public CampaignTerm getCampaignTermByUniversalSpec(final ExecutionErrorAccumulator eea,
124            final CampaignTermUniversalSpec universalSpec) {
125        return getCampaignTermByUniversalSpec(eea, universalSpec, EntityPermission.READ_ONLY);
126    }
127
128    public CampaignTerm getCampaignTermByUniversalSpecForUpdate(final ExecutionErrorAccumulator eea,
129            final CampaignTermUniversalSpec universalSpec) {
130        return getCampaignTermByUniversalSpec(eea, universalSpec, EntityPermission.READ_WRITE);
131    }
132    
133    public void setCampaignTermStatus(final Session session, ExecutionErrorAccumulator eea, CampaignTerm campaignTerm, String campaignTermStatusChoice, PartyPK modifiedBy) {
134        var entityInstanceControl = Session.getModelController(EntityInstanceControl.class);
135        var workflowControl = Session.getModelController(WorkflowControl.class);
136        var workflowLogic = WorkflowLogic.getInstance();
137        var workflow = workflowLogic.getWorkflowByName(eea, CampaignTermStatusConstants.Workflow_CAMPAIGN_TERM_STATUS);
138        var entityInstance = entityInstanceControl.getEntityInstanceByBasePK(campaignTerm.getPrimaryKey());
139        var workflowEntityStatus = workflowControl.getWorkflowEntityStatusByEntityInstanceForUpdate(workflow, entityInstance);
140        var workflowDestination = campaignTermStatusChoice == null ? null : workflowControl.getWorkflowDestinationByName(workflowEntityStatus.getWorkflowStep(), campaignTermStatusChoice);
141
142        if(workflowDestination != null || campaignTermStatusChoice == null) {
143            var workflowDestinationLogic = WorkflowDestinationLogic.getInstance();
144            var currentWorkflowStepName = workflowEntityStatus.getWorkflowStep().getLastDetail().getWorkflowStepName();
145            var map = workflowDestinationLogic.getWorkflowDestinationsAsMap(workflowDestination);
146            Long triggerTime = null;
147
148            if(currentWorkflowStepName.equals(CampaignTermStatusConstants.WorkflowStep_ACTIVE)) {
149                if(workflowDestinationLogic.workflowDestinationMapContainsStep(map, CampaignTermStatusConstants.Workflow_CAMPAIGN_TERM_STATUS, CampaignTermStatusConstants.WorkflowStep_INACTIVE)) {
150                    // Nothing at this time.
151                }
152            } else if(currentWorkflowStepName.equals(CampaignTermStatusConstants.WorkflowStep_INACTIVE)) {
153                if(workflowDestinationLogic.workflowDestinationMapContainsStep(map, CampaignTermStatusConstants.Workflow_CAMPAIGN_TERM_STATUS, CampaignTermStatusConstants.WorkflowStep_ACTIVE)) {
154                    // Nothing at this time.
155                }
156            }
157
158            if(eea == null || !eea.hasExecutionErrors()) {
159                workflowControl.transitionEntityInWorkflow(eea, workflowEntityStatus, workflowDestination, triggerTime, modifiedBy);
160            }
161        } else {
162            handleExecutionError(UnknownCampaignTermStatusChoiceException.class, eea, ExecutionErrors.UnknownCampaignTermStatusChoice.name(), campaignTermStatusChoice);
163        }
164    }
165
166}