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.WorkflowEntranceTransfer;
021import com.echothree.model.control.workflow.common.transfer.WorkflowTransfer;
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.WorkflowEntrance;
025import com.echothree.model.data.workflow.server.entity.WorkflowEntranceDetail;
026import com.echothree.util.common.form.TransferProperties;
027import java.util.Set;
028
029public class WorkflowEntranceTransferCache
030        extends BaseWorkflowTransferCache<WorkflowEntrance, WorkflowEntranceTransfer> {
031    
032    TransferProperties transferProperties;
033    boolean filterWorkflow;
034    boolean filterWorkflowEntranceName;
035    boolean filterIsDefault;
036    boolean filterSortOrder;
037    boolean filterDescription;
038    boolean filterEntityInstance;
039    
040    /** Creates a new instance of WorkflowEntranceTransferCache */
041    public WorkflowEntranceTransferCache(UserVisit userVisit, WorkflowControl workflowControl) {
042        super(userVisit, workflowControl);
043        
044        transferProperties = session.getTransferProperties();
045        if(transferProperties != null) {
046            var properties = transferProperties.getProperties(WorkflowEntranceTransfer.class);
047            
048            if(properties != null) {
049                filterWorkflow = !properties.contains(WorkflowProperties.WORKFLOW);
050                filterWorkflowEntranceName = !properties.contains(WorkflowProperties.WORKFLOW_ENTRANCE_NAME);
051                filterIsDefault = !properties.contains(WorkflowProperties.IS_DEFAULT);
052                filterSortOrder = !properties.contains(WorkflowProperties.SORT_ORDER);
053                filterDescription = !properties.contains(WorkflowProperties.DESCRIPTION);
054                filterEntityInstance = !properties.contains(WorkflowProperties.ENTITY_INSTANCE);
055            }
056        }
057        
058        setIncludeEntityInstance(!filterEntityInstance);
059    }
060    
061    public WorkflowEntranceTransfer getWorkflowEntranceTransfer(WorkflowEntrance workflowEntrance) {
062        WorkflowEntranceTransfer workflowEntranceTransfer = get(workflowEntrance);
063        
064        if(workflowEntranceTransfer == null) {
065            WorkflowEntranceDetail workflowEntranceDetail = workflowEntrance.getLastDetail();
066            WorkflowTransfer workflow = filterWorkflow ? null : workflowControl.getWorkflowTransfer(userVisit, workflowEntranceDetail.getWorkflow());
067            String workflowEntranceName = filterWorkflowEntranceName ? null : workflowEntranceDetail.getWorkflowEntranceName();
068            Boolean isDefault = filterIsDefault ? null : workflowEntranceDetail.getIsDefault();
069            Integer sortOrder = filterSortOrder ? null : workflowEntranceDetail.getSortOrder();
070            String description = filterDescription ? null : workflowControl.getBestWorkflowEntranceDescription(workflowEntrance, getLanguage());
071            
072            workflowEntranceTransfer = new WorkflowEntranceTransfer(workflow, workflowEntranceName, isDefault, sortOrder,
073                    description);
074            put(workflowEntrance, workflowEntranceTransfer);
075        }
076        
077        return workflowEntranceTransfer;
078    }
079    
080}