001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.workflow.server.transfer;
018
019import com.echothree.model.control.workflow.common.WorkflowProperties;
020import com.echothree.model.control.workflow.common.transfer.WorkflowStepTransfer;
021import com.echothree.model.control.workflow.server.control.WorkflowControl;
022import com.echothree.model.data.user.server.entity.UserVisit;
023import com.echothree.model.data.workflow.server.entity.WorkflowStep;
024import com.echothree.util.common.form.TransferProperties;
025import com.echothree.util.server.persistence.Session;
026import javax.enterprise.context.RequestScoped;
027
028@RequestScoped
029public class WorkflowStepTransferCache
030        extends BaseWorkflowTransferCache<WorkflowStep, WorkflowStepTransfer> {
031
032    WorkflowControl workflowControl = Session.getModelController(WorkflowControl.class);
033
034    TransferProperties transferProperties;
035    boolean filterWorkflow;
036    boolean filterWorkflowStepName;
037    boolean filterWorkflowStepType;
038    boolean filterIsDefault;
039    boolean filterSortOrder;
040    boolean filterHasDestinations;
041    boolean filterDescription;
042    boolean filterEntityInstance;
043    
044    /** Creates a new instance of WorkflowStepTransferCache */
045    protected WorkflowStepTransferCache() {
046        transferProperties = session.getTransferProperties();
047        if(transferProperties != null) {
048            var properties = transferProperties.getProperties(WorkflowStepTransfer.class);
049            
050            if(properties != null) {
051                filterWorkflow = !properties.contains(WorkflowProperties.WORKFLOW);
052                filterWorkflowStepName = !properties.contains(WorkflowProperties.WORKFLOW_STEP_NAME);
053                filterWorkflowStepType = !properties.contains(WorkflowProperties.WORKFLOW_STEP_TYPE);
054                filterIsDefault = !properties.contains(WorkflowProperties.IS_DEFAULT);
055                filterSortOrder = !properties.contains(WorkflowProperties.SORT_ORDER);
056                filterDescription = !properties.contains(WorkflowProperties.DESCRIPTION);
057                filterEntityInstance = !properties.contains(WorkflowProperties.ENTITY_INSTANCE);
058            }
059        }
060        
061        setIncludeEntityInstance(!filterEntityInstance);
062    }
063    
064    public WorkflowStepTransfer getWorkflowStepTransfer(UserVisit userVisit, WorkflowStep workflowStep) {
065        var workflowStepTransfer = get(workflowStep);
066        
067        if(workflowStepTransfer == null) {
068            var workflowStepDetail = workflowStep.getLastDetail();
069            var workflow = filterWorkflow ? null : workflowControl.getWorkflowTransfer(userVisit, workflowStepDetail.getWorkflow());
070            var workflowStepName = filterWorkflowStepName ? null : workflowStepDetail.getWorkflowStepName();
071            var workflowStepType = filterWorkflowStepType ? null : workflowControl.getWorkflowStepTypeTransfer(userVisit, workflowStepDetail.getWorkflowStepType());
072            var isDefault = filterIsDefault ? null : workflowStepDetail.getIsDefault();
073            var sortOrder = filterSortOrder ? null : workflowStepDetail.getSortOrder();
074            var hasDestinations = filterHasDestinations ? null : workflowControl.countWorkflowDestinationsByWorkflowStep(workflowStep) > 0;
075            var description = filterDescription ? null : workflowControl.getBestWorkflowStepDescription(workflowStep, getLanguage(userVisit));
076            
077            workflowStepTransfer = new WorkflowStepTransfer(workflow, workflowStepName, workflowStepType, isDefault, sortOrder,
078                    hasDestinations, description);
079            put(userVisit, workflowStep, workflowStepTransfer);
080        }
081        
082        return workflowStepTransfer;
083    }
084    
085}