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.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.common.transfer.WorkflowStepTypeTransfer;
022import com.echothree.model.control.workflow.common.transfer.WorkflowTransfer;
023import com.echothree.model.control.workflow.server.control.WorkflowControl;
024import com.echothree.model.data.user.server.entity.UserVisit;
025import com.echothree.model.data.workflow.server.entity.WorkflowStep;
026import com.echothree.model.data.workflow.server.entity.WorkflowStepDetail;
027import com.echothree.util.common.form.TransferProperties;
028import java.util.Set;
029
030public class WorkflowStepTransferCache
031        extends BaseWorkflowTransferCache<WorkflowStep, WorkflowStepTransfer> {
032    
033    TransferProperties transferProperties;
034    boolean filterWorkflow;
035    boolean filterWorkflowStepName;
036    boolean filterWorkflowStepType;
037    boolean filterIsDefault;
038    boolean filterSortOrder;
039    boolean filterHasDestinations;
040    boolean filterDescription;
041    boolean filterEntityInstance;
042    
043    /** Creates a new instance of WorkflowStepTransferCache */
044    public WorkflowStepTransferCache(UserVisit userVisit, WorkflowControl workflowControl) {
045        super(userVisit, workflowControl);
046        
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(WorkflowStep workflowStep) {
066        WorkflowStepTransfer workflowStepTransfer = get(workflowStep);
067        
068        if(workflowStepTransfer == null) {
069            WorkflowStepDetail workflowStepDetail = workflowStep.getLastDetail();
070            WorkflowTransfer workflow = filterWorkflow ? null : workflowControl.getWorkflowTransfer(userVisit, workflowStepDetail.getWorkflow());
071            String workflowStepName = filterWorkflowStepName ? null : workflowStepDetail.getWorkflowStepName();
072            WorkflowStepTypeTransfer workflowStepType = filterWorkflowStepType ? null : workflowControl.getWorkflowStepTypeTransfer(userVisit, workflowStepDetail.getWorkflowStepType());
073            Boolean isDefault = filterIsDefault ? null : workflowStepDetail.getIsDefault();
074            Integer sortOrder = filterSortOrder ? null : workflowStepDetail.getSortOrder();
075            Boolean hasDestinations = filterHasDestinations ? null : workflowControl.countWorkflowDestinationsByWorkflowStep(workflowStep) > 0;
076            String description = filterDescription ? null : workflowControl.getBestWorkflowStepDescription(workflowStep, getLanguage());
077            
078            workflowStepTransfer = new WorkflowStepTransfer(workflow, workflowStepName, workflowStepType, isDefault, sortOrder,
079                    hasDestinations, description);
080            put(workflowStep, workflowStepTransfer);
081        }
082        
083        return workflowStepTransfer;
084    }
085    
086}