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